inoreader-api 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa0262c517e47bef19e82c90cefa27fb432ac3b5
+  data.tar.gz: 0e97fe585a014d3660b0d22ed595194dc1961892
+SHA512:
+  metadata.gz: 1de9738b02e45a77ea0384b4db4d98668b80e66310379f3cf40885385891d6855912e0e2fd4a0bfcd11b00fcbbea7e7496ee4cc30772df37f0ff879217e57c7a
+  data.tar.gz: 399baebe15d15b8a06dc3f7f4deabf1007ef5060d21a5270c800456b9b3c53470835e851099f4a5113d4947d354e863bce6ac77b197a6f63ac684f3b23abf1d2

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+
+spec/real_request_spec.rb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inoreader-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kyohei8
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,239 @@
+# Simple api client of [InoReader](http://inoreader.com/)
+
+This gem is Simple api client of [InoReader](http://inoreader.com/)
+
+InoReader official API is [here](http://wiki.inoreader.com/doku.php?id=api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'inoreader-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inoreader-api
+
+## Usage
+
+### Initialize
+
+#### Initialize with Login
+
+```ruby
+require 'inoreader-api'
+
+inoreader = InoreaderApi::Api.new(:username => 'username', :password => 'password')
+inoreader.auth_token # => 'G2UlCa...Fx'
+```
+
+#### Initialize with Token
+
+```ruby
+require 'inoreader-api'
+
+inoreader = InoreaderApi::Api.new(:auth_token => 'yourtoken')
+inoreader.auth_token # => yourtoken
+```
+
+### Token
+
+```ruby
+inoreader.token # => yourtoken
+```
+
+### User info
+
+```ruby
+user = inoreader.user_info
+user.userId # => '1005921515'
+user.userName # => 'Jacket'
+```
+
+### Get unread counters
+
+```ruby
+unread = inoreader.unread_counters
+unread.max # => 1000
+```
+
+### List of user subscriptions
+
+```ruby
+inoreader.user_subscription
+```
+
+### List of user tags and folders
+
+```ruby
+inoreader.user_tags_folders
+```
+
+### Stream
+
+#### feed items
+
+For additional parameter about any of the request, see the http://wiki.inoreader.com/doku.php?id=api#stream_contents
+
+``` ruby
+# retrieve all feed item
+inoreader.items
+# => #<Hashie::Mash continuation="bHe_p00GLz2u" description="" direction="ltr"...
+
+# with parameter
+inoreader.items('feed/http://feeds.test.com/',{
+  :n      => 10,
+  :r      => 'o',
+  :ot     => '1389756192',
+  :xt     => 'user/-/state/com.google/read',
+  :it     => 'user/-/state/com.google/read',
+  :c      => 'Beg3ah6v3'
+})
+```
+
+#### item ids
+
+```ruby
+# retrieve all item ids
+inoreader.item_ids
+# => #<Hashie::Mash continuation="eCpdOmg58fOF" itemRefs=[...
+
+# with parameter
+inoreader.item_ids('feed/http://feeds.test.com/',{
+  :n      => 10,
+  :r      => 'o',
+  :ot     => '1389756192',
+  :xt     => 'user/-/state/com.google/read',
+  :it     => 'user/-/state/com.google/read',
+  :c      => 'Beg3ah6v3'
+})
+```
+
+### Tags
+
+#### Rename tag
+
+```ruby
+inoreader.rename_tag('oldtag','newtag') # => 'OK'
+```
+
+#### Delete tag
+
+```ruby
+inoreader.disable_tag('tagname') # => 'OK'
+```
+
+#### Add tag
+
+```ruby
+inoreader.add_tag('1719158580', 'user/-/state/com.google/read') # => 'OK'
+# or
+inoreader.add_tag('tag:google.com,2005:reader/item/000000006678359d', 'user/-/state/com.google/read') # => 'OK'
+```
+
+#### Remove tag
+
+```ruby
+inoreader.remove_tag('1719158580', 'user/-/state/com.google/read') # => 'OK'
+# or
+inoreader.remove_tag('tag:google.com,2005:reader/item/000000006678359d', 'user/-/state/com.google/read') # => 'OK'
+```
+
+### Mark all as read
+
+```ruby
+# specify label
+inoreader.mark_all_as_read(1373407120123456, 'user/-/label/Google') # => 'OK'
+
+# or feed
+inoreader.mark_all_as_read(1373407120123456, 'feed/http://feeds.test.com/') # => 'OK'
+```
+
+### Subscription
+
+#### Add subscription (feed)
+
+```ruby
+inoreader.add_subscription('http://newfeeditem.com/')
+# => #<Hashie::Mash numResults=1 query="http://newfeeditem.com/" streamId="feed/http://rss.newfeeditem.com/feeds">
+```
+
+#### Rename subscription
+
+```ruby
+inoreader.rename_subscription('feed/http://rss.newfeeditem.com/feeds', 'new title')  # => 'OK'
+```
+
+#### Add folder
+
+```ruby
+inoreader.add_folder_subscription('feed/http://rss.newfeeditem.com/feeds', 'folderName') # => 'OK'
+```
+
+#### Remove folder
+
+```ruby
+inoreader.remove_folder_subscription('feed/http://rss.newfeeditem.com/feeds', 'folderName') # => 'OK'
+```
+
+#### unsubscribe
+
+```ruby
+inoreader.unsubscribe('feed/http://rss.newfeeditem.com/feeds') # => 'OK'
+```
+
+#### subscribe
+
+```ruby
+inoreader.subscribe('feed/http://rss.newfeeditem.com/feeds') # => 'OK'
+# with folder
+inoreader.subscribe('feed/http://rss.newfeeditem.com/feeds', 'newFolder') # => 'OK'
+```
+
+### Preferences list
+
+```ruby
+inoreader.preferences_list
+# => #<Hashie::Mash prefs=[#<Hashie::Mash id="lhn-prefs" value="{\"subscriptions\":{\"ssa\":\"false\"}}">]>
+```
+
+
+### Stream preferences list
+
+```ruby
+inoreader.stream_preferences_list
+# => #<Hashie::Mash streamprefs=#<Hashie::Mash...
+```
+
+### Set subscription ordering
+
+```ruby
+inoreader.set_subscription_ordering('user/-/state/com.google/root', '00A3AAB000B9C8F9')# => 'OK'
+```
+
+## httparty mode
+If you attach the `:return_httparty_response => true` when the initiarize, you can return the response of httparty.
+
+[httparty(github)](https://github.com/jnunemaker/httparty)
+
+```ruby
+inoreader = InoreaderApi::Api.new(
+  :auth_token => 'token',
+  :return_httparty_response => true
+)
+
+inoreader.item_ids
+# <HTTParty::Response:0x7fe10416dd60 parsed_response={"items"=>[], "itemRefs"=>[{"id"=>"1719385305", "directStreamIds"=>[], ...
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/inoreader-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inoreader/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inoreader-api"
+  spec.version       = Inoreader::Api::VERSION
+  spec.authors       = ["kyohei8"]
+  spec.email         = ["tsukuda.kyouhei@gmail.com"]
+  spec.description   = %q{InoReader Ruby Client}
+  spec.summary       = %q{InoReader Ruby Client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'hashie'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+
+end

data/lib/inoreader-api.rb

@@ -0,0 +1 @@
+require(File.join(File.dirname(__FILE__), "inoreader", "api"))

data/lib/inoreader/api.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+require 'inoreader/api/app'
+require 'inoreader/api/helper'
+
+module InoreaderApi
+  class InoreaderApiError < StandardError; end
+end

data/lib/inoreader/api/app.rb

@@ -0,0 +1,228 @@
+# coding: utf-8
+require 'json'
+
+module InoreaderApi
+  class Api
+    # set auth toke or username/password
+    # @param [Hash] options
+    # @option auth_token [String] auth token
+    # @option username [String] username
+    # @option password [String] password
+    # @option return_httparty_response [Boolean]
+    # @return [String] auth token
+    def initialize(options={})
+      # set default
+      options = {
+        :return_httparty_response => false
+      }.merge(options)
+      @auth_token = options.delete(:auth_token)
+      if !@auth_token && options.has_key?(:username) && options.has_key?(:password)
+        username = options.delete(:username)
+        password = options.delete(:password)
+        res = login(username, password)
+        @auth_token = res
+      end
+
+      InoreaderApi::Helper.return_httparty_response = options[:return_httparty_response]
+    end
+
+    # return to auth token
+    def auth_token
+      @auth_token
+    end
+
+    # get user info
+    # @return [String] json string "{"userId":"XXXXXXXXX", "userName":"user_name", ...}"
+    def user_info
+      Helper.request '/reader/api/0/user-info', {:query => {:T => @auth_token}}
+    end
+
+    # get token
+    # @return [String] token. ex."aFP4xIm2Ow...."
+    def token
+      Helper.request '/reader/api/0/token', {:query => {:T => @auth_token}}
+    end
+
+    # OPML Import
+    def import
+      # todo
+    end
+
+    # get unread counters
+    def unread_counters
+      Helper.request '/reader/api/0/unread-count?output=json', {:query => {:T => @auth_token}}
+    end
+
+    # get user subscriptions
+    def user_subscription
+      Helper.request '/reader/api/0/subscription/list', {:query => {:T => @auth_token}}
+    end
+
+    # get user tags/folders
+    def user_tags_folders
+      Helper.request '/reader/api/0/tag/list', {:query => {:T => @auth_token}}
+    end
+
+    # stream
+    #  output format : json only
+    # @param [String] path request path
+    # @param [String] feed id of subscription
+    # @param [Hash] params request Parameters
+    # @option params [Number] :n Number of items. (default 20, max 1000)
+    # @option params [String] :r Order. (default is newest first. 'o' is oldest first)
+    # @option params [String] :ot Start time (unix timestamp. ex.1389756192)
+    # @option params [String] :xt Exclude Target. (ex. 'user/-/state/com.google/read')
+    # @option params [String] :it Include Target. ('user/-/state/com.google/read(,starred,like)')
+    # @option params [String] :c Continuation.
+    def stream(path, feed='', params={})
+      query = {:query => params.merge!(:T => @auth_token, :output => 'json')}
+      feed_name = feed.empty? ? '' : ('/' + feed)
+      Helper.request "#{path}#{feed_name}", query
+    end
+
+    # get user items
+    # @see InoreaderApi::Api#stream
+    def items(feed='', params={})
+      stream '/reader/atom', feed, params
+    end
+
+    # get user item ids
+    # @see InoreaderApi::Api#stream
+    def item_ids(feed='', params={})
+      stream '/reader/api/0/stream/items/ids', feed, params
+    end
+
+    ## tag ##
+
+    # rename tag
+    # @param source source tag
+    # @param dest   dest tag
+    def rename_tag(source, dest)
+      Helper.request '/reader/api/0/rename-tag', {:query => {:T => @auth_token, s: source, dest: dest}}, :post
+    end
+
+    # delete(disable) tag
+    def disable_tag(tag_name)
+      Helper.request '/reader/api/0/disable-tag', {:query => {:T => @auth_token, s: tag_name}}, :post
+    end
+
+    # add tag
+    # @param [String] items Item IDs(short or long)
+    # @param [String] add_tag use SpecialTag or custom tag
+    def add_tag(items, add_tag=nil)
+      Helper.request '/reader/api/0/edit-tag', {:query => {:T => @auth_token, :i => items, :a => add_tag}}, :post
+    end
+
+    # remove tag
+    # @param [Array] items Item IDs(short or long)
+    # @param [String] remove_tag SpecialTag or custom tag
+    def remove_tag(items, remove_tag)
+      Helper.request '/reader/api/0/edit-tag', {:query => {:T => @auth_token, :i => items, :r => remove_tag}}, :post
+    end
+
+    # mark all as read. mark as read, older than ts.
+    # @param [String] ts microseconds.
+    # @param [String] s Stream.
+    def mark_all_as_read(ts, s)
+      Helper.request '/reader/api/0/mark-all-as-read', {:query => {:T => @auth_token, :ts => ts, :s => s}}, :post
+    end
+
+    # add Subscription
+    # @param [String] url specify the URL to add.
+    def add_subscription(url)
+      Helper.request '/reader/api/0/subscription/quickadd', {:query => {:T => @auth_token, quickadd: url}}, :post
+    end
+
+    # edit subscription
+    # @param [String] ac action ('edit' or 'subscribe' or 'unsubscribe')
+    # @param [String] s stream id(feed/feed_url)
+    # @param [String] t subscription title. Omit this parameter to keep the title unchanged
+    # @param [String] a add subscription to folder/tag.
+    # @param [String] r remove subscription from folder/tag.
+    def edit_subscription(ac, s, t=nil, a=nil, r=nil)
+      query = {:T => @auth_token, :ac => ac, :s => s}
+      query[:t] = t unless t.nil?
+      query[:a] = a unless a.nil?
+      query[:r] = r unless r.nil?
+      Helper.request '/reader/api/0/subscription/edit', {:query => query}, :post
+    end
+
+    # rename subscription title
+    # @param [String] s stream id(feed/feed_url)
+    # @param [String] t subscription new title.
+    def rename_subscription(s, t)
+      edit_subscription :edit, s, t
+    end
+
+    # add folder to subscription
+    # @param [String] s stream id(feed/feed_url)
+    # @param [String] a add subscription to folder
+    def add_folder_subscription(s, a)
+      edit_subscription :edit, s, nil, a
+    end
+
+    # remove folder to subscription
+    # @param [String] s stream id(feed/feed_url)
+    # @param [String] r remove subscription to folder
+    def remove_folder_subscription(s, r)
+      edit_subscription :edit, s, nil, nil, r
+    end
+
+    # unsubscribe
+    # @param [String] s stream id(feed/feed_url)
+    def unsubscribe(s)
+      edit_subscription :unsubscribe, s
+    end
+
+    # subscribe (=add Subscription)
+    # @param [String] s stream id(feed/feed_url)
+    # @param [String] a folder name
+    def subscribe(s, a)
+      edit_subscription :subscribe, s, nil, a
+    end
+
+    # preference list:current subscriptions sorting.
+    def preferences_list
+      Helper.request '/reader/api/0/preference/list', {:query => {:T => @auth_token}}
+    end
+
+    # Stream preferences list
+    def stream_preferences_list
+      Helper.request '/reader/api/0/preference/stream/list', {:query => {:T => @auth_token}}
+    end
+
+    # @param [String] s stream id. root or folder name
+    # @param [String] k key
+    # @param [String] v value
+    def set_stream_preferences(s, k, v)
+      query = {:query => {:T => @auth_token, :s => s, :k => k, :v => v}}
+      Helper.request '/reader/api/0/preference/stream/set', query, :post
+    end
+
+    # Set stream preferences. now is “subscription-ordering” only :P
+    # @param [String] s stream id. 'root' or folder name
+    # @param [String] v sorting value
+    def set_subscription_ordering(s, v)
+      set_stream_preferences(s, 'subscription-ordering', v)
+    end
+
+    private
+    # Authenticate, to return authToken
+    # @param un username or Email
+    # @param pw Password
+    # @return Hash
+    # if success
+    # {
+    #   :auth_token => xxxxxxxx
+    # }
+    #
+    def login(un, pw)
+      response_body = Helper.auth_request un, pw
+      auth_token = Hash[*response_body.split.collect { |i| i.split('=') }.flatten]['Auth']
+      raise InoreaderApi::InoreaderApiError.new 'Bad Authentication' if auth_token.nil?
+      auth_token
+    rescue => e
+      raise InoreaderApi::InoreaderApiError.new e.message if auth_token.nil?
+    end
+  end
+end