Project

annict

0.0
No commit activity in last 3 years
No release in over 3 years
annictalitaso345/annict-rubyHomepageDocumentationSource CodeBug TrackerWiki
Annict API v1 client library, written in Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,848
Stars
3
Forks
0
Watchers
1
 Releases
Current version
0.0.1
Total releases
1
First release
2017-03-20
Latest release
2017-03-20
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-03-20
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.14
pry
>= 0
rake
~> 10.0
rspec
~> 3.0

Runtime

faraday
~> 0.9
faraday_middleware
>= 0
 Project Readme

annict-ruby

A Ruby interface for Annict API

Installation

Add this line to your application's Gemfile:

gem 'annict'

And then execute:

$ bundle

Or install it yourself as:

$ gem install annict

Documentation

https://docs.annict.com/

Usage

Annict::Client.new

require 'annict'
client = Annict::Client.new(access_token: 'annict_access_token')

Annict::Client#works

Available params

  • :fields
  • :filter_ids
  • :filter_season
  • :filter_title
  • :page
  • :per_page
  • :sort_id
  • :sort_season
  • sort_watchers_count
client.works
#=> GET /v1/works

Annict::Client#episodes

Available params

  • :fields
  • :filter_ids
  • :filter_work_id
  • :page
  • :per_page
  • :sort_id
  • :sort_sort_number
client.episodes
#=> GET /v1/episodes

Annict::Client#records

Available params

  • :fields
  • :filter_ids
  • :filter_episode_id
  • :filter_has_record_comment
  • :page
  • :per_page
  • :sort_id
  • :sort_likes_count
client.records
#=> GET /v1/records

Annict::Client#users

Available params

  • :fields
  • :filter_ids
  • :filter_usernames
  • :page
  • :per_page
  • :sort_id
client.users
#=> GET /v1/users

Annict::Client#following

Available params

  • :fields
  • :filter_user_id
  • :filter_usernames
  • :page
  • :per_page
  • :sort_id
client.following
#=> GET /v1/following

Annict::Client#followers

Available params

  • :fields
  • :filter_user_id
  • :filter_usernames
  • :page
  • :per_page
  • :sort_id
client.followers
#=> GET /v1/followers

Annict::Client#activities

Available params

  • :fields
  • :filter_user_id
  • :filter_usernames
  • :page
  • :per_page
  • :sort_id
client.activities
#=> GET /v1/activities

Annict::Client#me

Available params

  • :fields
client.me
#=> GET /v1/me

Annict::Client#change_status

Necessary params

  • :word_id
  • :kind
client.change_status({ work_id: 1808, kind: 'wanna_watch' })
#=> POST /v1/me/statuses

Annict::Client#add_record

Necessary params

  • :episode_id

Available params

  • :comment
  • :rating
  • :share_twitter
  • :share_facebook
client.add_record({ episode_id: 1808, comment: 'えるたそ〜' })
#=> POST /v1/me/records

Annict::Client#own_works

Available params

  • :fields
  • :filter_ids
  • :filter_season
  • :filter_title
  • :filter_status
  • :page
  • :per_page
  • :sort_id
  • :sort_season
  • :sort_watchers_count
client.own_works
#=> GET /v1/me/works

Annict:Client#programs

Available params

  • :fields
  • :filter_ids
  • :filter_channel_ids
  • :filter_work_ids
  • :filter_started_at_gt
  • :filter_started_at_lt
  • :filter_unwatched
  • :filter_rebroadcast
  • :page
  • :per_page
  • :sort_id
  • :sort_started_at
client.programs
#=> GET /v1/me/programs

Annict::Client#following_activities

Available params

  • :fields
  • :filter_actions
  • :filter_muted
  • :page
  • :per_page
  • :sort_id
client.following_activities
#=> GET /v1/me/following_activities

Contributing

  1. Fork it ( https://github.com/alitaso345/annict-ruby/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

The gem is available as open source under the terms of the MIT License.