inoreader-api 0.9.0

data/lib/inoreader/api/helper.rb

@@ -0,0 +1,77 @@
+# coding: utf-8
+require 'httparty'
+require 'multi_json'
+require 'hashie'
+
+module InoreaderApi
+  class Helper
+    include HTTParty
+
+    attr_accessor :ret
+
+    debug = false
+    if debug
+      debug_output $stdout
+    end
+    self.disable_rails_query_string_format
+
+    base_uri 'https://www.inoreader.com'
+
+    class << self
+
+      # option: use httparty respqnse if set true
+      @@return_httparty_response = false
+
+      def return_httparty_response=(bool)
+        @@return_httparty_response = bool
+      end
+
+
+      # send request
+      # @param [String] path request path
+      # @param [Hash] query URL params  ex. {:query => {:T => 'token', :ref => 'bar'}}
+      # @param [Symbol] method :get or :post
+      # @return response body
+      def request(path, query=nil, method=:get)
+
+        begin
+          response = self.send(method, path, query)
+        rescue => e
+          #request fail (ex. timeout)
+          raise InoreaderApiError.new e.message
+        end
+
+        if response.response.code == '200'
+          if @@return_httparty_response
+            response
+          else
+            begin
+              #return to hashie
+              Hashie::Mash.new MultiJson.decode(response.body)
+            rescue
+              # its not JSON, return body directly.
+              response.body
+            end
+          end
+        else
+          # request fail (ex. 500, 401...)
+          raise InoreaderApiError.new response.response.message
+        end
+      end
+
+      # auth request to Inoreader
+      # @param [String] un username
+      # @param [String] pw password
+      # @return response body
+      def auth_request(un, pw)
+        response = self.post('/accounts/ClientLogin', {:body => {:Email => un, :Passwd => pw}})
+        if response.response.code == '200'
+          # request fail (ex. 500, 401...)
+          response.body
+        else
+          raise InoreaderApiError.new response.response.message
+        end
+      end
+    end
+  end
+end

data/lib/inoreader/api/version.rb

@@ -0,0 +1,5 @@
+module Inoreader
+  module Api
+    VERSION = "0.9.0"
+  end
+end

data/spec/api_auth_spec.rb

@@ -0,0 +1,57 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe 'InoreaderApi::Api auth' do
+
+  it 'should correct auth' do
+    set_auth_stub('dummy_name', 'dummy_pass', 200, "SID=null\nLSID=null\nAuth=thisisdummyauthkey!321")
+    ino = InoreaderApi::Api.new(
+      :username => 'dummy_name',
+      :password => 'dummy_pass'
+    )
+    ino.auth_token.should == 'thisisdummyauthkey!321'
+  end
+
+  it 'should auth failed (unAuthorizing)' do
+    set_auth_stub('fail', 'pass', [400, 'Authorization Required'], 'Error=BadAuthentication')
+    proc {
+      InoreaderApi::Api.new(
+        :username => 'fail',
+        :password => 'pass'
+      )
+    }.should raise_error(InoreaderApi::InoreaderApiError, 'Authorization Required')
+  end
+
+  it 'should auth failed 500' do
+    set_auth_stub('error', 'pass', [500, 'Internal Server Error'], '')
+    proc {
+      InoreaderApi::Api.new(
+        :username => 'error',
+        :password => 'pass'
+      )
+    }.should raise_error(InoreaderApi::InoreaderApiError, 'Internal Server Error')
+  end
+
+  it 'should to timeout' do
+    stub_request(:post, 'https://www.inoreader.com/accounts/ClientLogin').
+      with(:body => 'Email=timeout_name&Passwd=fail_pass').to_timeout
+
+    proc {
+      InoreaderApi::Api.new(
+        :username => 'timeout_name',
+        :password => 'fail_pass'
+      )
+    }.should raise_error(InoreaderApi::InoreaderApiError, 'execution expired')
+  end
+
+  it 'should get token' do
+    stub_request(:get, 'https://www.inoreader.com/reader/api/0/token?T=dummy_token').
+      to_return(
+      :status  => 200,
+      :body    => 'dummy_token',
+      :headers => {}
+    )
+    ino = InoreaderApi::Api.new(:auth_token => 'dummy_token')
+    ino.instance_variable_get(:@auth_token).should == 'dummy_token'
+  end
+end

data/spec/api_get_method_spec.rb

@@ -0,0 +1,60 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe 'InoreaderApi::Api#unread_counters' do
+  it 'should get unread count' do
+    body = '{"max":"1000","unreadcounts":[{"id":"user\/9999999999\/state\/com.google\/reading-list","count":1000,"newestItemTimestampUsec":"1390821452642780"}]}'
+    stub_request(:get, make_url(REQUEST_PATH[:unread_count], {
+      :T      => 'dummy_token',
+      :output => 'json'
+    })).to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+    res = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).unread_counters
+    res[:max].should == '1000'
+    res.unreadcounts[0].id == 'user/9999999999/state/com.google/reading-list'
+    res.unreadcounts[0].count == 1000
+    res.unreadcounts[0].newestItemTimestampUsec == '1390821452642780'
+  end
+end
+
+describe 'InoreaderApi::Api#user_subscription' do
+  it 'should get user subscription' do
+    body = '{"subscriptions":[{ "id":"feed\/http:\/\/feeds.feedburner.com\/AjaxRain"}]}'
+    stub_request(:get, make_url(REQUEST_PATH[:subscription], {
+      :T => 'dummy_token'
+    })).to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+
+    res = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).user_subscription
+    res.subscriptions[0].id.should == 'feed/http://feeds.feedburner.com/AjaxRain'
+  end
+end
+
+describe 'InoreaderApi::Api#user_tags_folders' do
+  it 'should get user tags' do
+    body = '{"tags": [{ "id": "user\/9999999999\/state\/com.google\/starred", "sortid": "FFFFFFFF" }]}'
+    stub_request(:get, make_url(REQUEST_PATH[:tag], {
+      :T => 'dummy_token'
+    })).to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+
+    res = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).user_tags_folders
+    res.tags[0].id.should == 'user/9999999999/state/com.google/starred'
+    res.tags[0].sortid.should == 'FFFFFFFF'
+  end
+end

data/spec/api_mark_all_as_read_spec.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe 'InoreaderApi::Api mark all as read manipulation' do
+
+  it 'should mark all as read ' do
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:mark_all_as_read], {
+      :T  => 'dummy_token',
+      :ts => 1373407120123456,
+      :s  => feed
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).mark_all_as_read(1373407120123456, feed).should == 'OK'
+
+  end
+end

data/spec/api_preferences_spec.rb

@@ -0,0 +1,62 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe 'InoreaderApi::Api preferences manipulation' do
+
+  it 'should get preferences list' do
+    body = '{ "prefs": [{"id": "lhn-prefs", "value": "{\"subscriptions\":{\"ssa\":\"false\"}}"}]}'
+    stub_request(:get, make_url(REQUEST_PATH[:preference_list], {
+      :T => 'dummy_token',
+    })).to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).preferences_list['prefs'].should == [
+      {
+        "id"    => "lhn-prefs",
+        "value" => "{\"subscriptions\":{\"ssa\":\"false\"}}"
+      }]
+  end
+
+
+  it 'should get stream preferences list' do
+    body = '{"streamprefs": { "root": [{"id":"subscription-ordering", "value": "00BED5"}]}}'
+
+    stub_request(:get, make_url(REQUEST_PATH[:stream_preferences_list], {
+      :T => 'dummy_token',
+    })).to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+
+    hashie_response = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).stream_preferences_list
+    hashie_response.streamprefs.root[0].id.should == 'subscription-ordering'
+    hashie_response.streamprefs.root[0].value.should == '00BED5'
+
+  end
+
+  it 'should set preferences list' do
+
+    stub_request(:post, make_url(REQUEST_PATH[:set_stream_preferences], {
+      :T => 'dummy_token',
+      :k => 'subscription-ordering',
+      :s => 'user/-/state/com.google/root',
+      :v => '00A3AAB000B9C8F9',
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).set_subscription_ordering('user/-/state/com.google/root', '00A3AAB000B9C8F9').should == 'OK'
+  end
+end

data/spec/api_stream_spec.rb

@@ -0,0 +1,154 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe 'Inoreader::Api#stream' do
+
+  it 'should get all item ids' do
+    body = '{"items":[],"itemRefs":[{"id":"9878"}]}'
+    stub_request(:get, make_url(REQUEST_PATH[:item_ids], {
+      :T      => 'dummy_token',
+      :output => 'json'
+    })).to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+
+    hashie_response = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).item_ids
+    hashie_response.itemRefs[0].id.should == '9878'
+    hashie_response.items == []
+
+    httparty_response = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token',
+      :return_httparty_response => true
+    ).item_ids
+    httparty_response.body.should == body
+
+  end
+
+  it 'should get feeds item ids' do
+    body = '{"items":[],"itemRefs":[{"id":"9878"}]}'
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:get, make_url(REQUEST_PATH[:item_ids], {
+      :T      => 'dummy_token',
+      :n      => 10,
+      :r      => 'o',
+      :ot     => '1389756192',
+      :xt     => 'user/-/state/com.google/read',
+      :it     => 'user/-/state/com.google/read',
+      :c      => 'asdfgqer',
+      :output => 'json'
+    }, feed)).to_return(
+      :status => 200,
+      :body => body,
+      :headers => {}
+    )
+
+    hashie_response = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).item_ids(feed, {
+      :n  => 10,
+      :r  => 'o',
+      :ot => '1389756192',
+      :xt => 'user/-/state/com.google/read',
+      :it => 'user/-/state/com.google/read',
+      :c  => 'asdfgqer'
+    })
+    hashie_response.itemRefs[0].id.should == '9878'
+    hashie_response.items.should == []
+
+
+    httparty_response = InoreaderApi::Api.new(
+      :auth_token               => 'dummy_token',
+      :return_httparty_response => true
+    ).item_ids(feed, {
+      :n  => 10,
+      :r  => 'o',
+      :ot => '1389756192',
+      :xt => 'user/-/state/com.google/read',
+      :it => 'user/-/state/com.google/read',
+      :c  => 'asdfgqer'
+    })
+
+    httparty_response.body.should == body
+  end
+
+  # check items api
+  it 'should get all feed items' do
+    body = '{"direction": "ltr","title": "Reading List","items":[{"id": "tag:00001"}]}'
+    stub_request(:get, make_url(REQUEST_PATH[:items], {
+      :T      => 'dummy_token',
+      :output => 'json'
+    })).
+      to_return(
+      :status  => 200,
+      :body    => body,
+      :headers => {}
+    )
+
+    hashie_response = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).items
+    hashie_response.direction.should == 'ltr'
+    hashie_response.title.should == 'Reading List'
+    hashie_response.items.count.should == 1
+    hashie_response.items[0].id.should == 'tag:00001'
+
+    httparty_response = InoreaderApi::Api.new(
+      :auth_token               => 'dummy_token',
+      :return_httparty_response => true
+    ).items
+    httparty_response.body.should == body
+  end
+
+  it 'should get feeds items' do
+    body = '{"direction": "ltr","title": "feed1","items":[{"id": "tag:00001"}]}'
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:get, make_url(REQUEST_PATH[:items], {
+      :T  => 'dummy_token',
+      :n  => 10,
+      :r  => 'o',
+      :ot => '1389756192',
+      :xt => 'user/-/state/com.google/read',
+      :it => 'user/-/state/com.google/read',
+      :c  => 'Beg3ah6v3',
+      :output => 'json'
+    },feed)).to_return(
+      :status => 200,
+      :body => body,
+      :headers => {}
+    )
+
+    hashie_response = InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).items(feed, {
+      :n  => 10,
+      :r  => 'o',
+      :ot => '1389756192',
+      :xt => 'user/-/state/com.google/read',
+      :it => 'user/-/state/com.google/read',
+      :c  => 'Beg3ah6v3'
+    })
+    hashie_response.direction.should == 'ltr'
+    hashie_response.title.should == 'feed1'
+    hashie_response.items.count.should == 1
+    hashie_response.items[0].id.should == 'tag:00001'
+
+    httparty_response = InoreaderApi::Api.new(
+      :auth_token               => 'dummy_token',
+      :return_httparty_response => true
+    ).items(feed, {
+      :n  => 10,
+      :r  => 'o',
+      :ot => '1389756192',
+      :xt => 'user/-/state/com.google/read',
+      :it => 'user/-/state/com.google/read',
+      :c  => 'Beg3ah6v3'
+    })
+
+    httparty_response.body.should == body
+  end
+
+end

data/spec/api_subscription_spec.rb

@@ -0,0 +1,112 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe 'InoreaderApi::Api Subscription manipulation' do
+
+  it 'should add Subscription' do
+    url = 'http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:add_subscription], {
+      :T        => 'dummy_token',
+      :quickadd => url
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).add_subscription(url).should == 'OK'
+  end
+
+  it 'should rename Subscription' do
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:edit_subscription], {
+      :T  => 'dummy_token',
+      :ac => :edit,
+      :s  => feed,
+      :t  => 'new title'
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).rename_subscription(feed, 'new title').should == 'OK'
+
+  end
+
+  it 'should add to folder a Subscription' do
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:edit_subscription], {
+      :T  => 'dummy_token',
+      :ac => :edit,
+      :s  => feed,
+      :a  => 'new folder'
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).add_folder_subscription(feed, 'new folder').should == 'OK'
+  end
+
+  it 'should remove from Subscription to folder' do
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:edit_subscription], {
+      :T  => 'dummy_token',
+      :ac => :edit,
+      :s  => feed,
+      :r  => 'new folder'
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).remove_folder_subscription(feed, 'new folder').should == 'OK'
+  end
+
+  it 'should unsubscribe' do
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:edit_subscription], {
+      :T  => 'dummy_token',
+      :ac => :unsubscribe,
+      :s  => feed,
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).unsubscribe(feed).should == 'OK'
+  end
+
+  it 'should subscribe' do
+    feed = 'feed/http://feeds.feedburner.com/AjaxRain'
+    stub_request(:post, make_url(REQUEST_PATH[:edit_subscription], {
+      :T  => 'dummy_token',
+      :ac => :subscribe,
+      :s  => feed,
+      :a  => 'new folder',
+    })).to_return(
+      :status  => 200,
+      :body    => 'OK',
+      :headers => {}
+    )
+
+    InoreaderApi::Api.new(
+      :auth_token => 'dummy_token'
+    ).subscribe(feed, 'new folder').should == 'OK'
+  end
+
+end