theoldreader-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a7b1508c70f8afe65833e5fbd8f31333f451443
+  data.tar.gz: cb606e24bb3108aed1d340e02376a556a88a9804
+SHA512:
+  metadata.gz: f93692c353a6164464e7a6d0c180ee2fb65fd0f32155b998e413211e21637a20a37d1df1db30e509a05326307b6bb20803e9922429007e7a3892fa9926d9e483
+  data.tar.gz: 7501fff2026baf97076709d4cebc30934ec5bf9f2fc4a1473cff2e5b4d0c650c839adbf11037232287f621396fc7375a0b489f8d18cebdb9b80249bbc24e7ef3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.3
+before_install: gem install bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ilia Zemskov
+
+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,112 @@
+# Theoldreader::Api
+
+Ruby wrapper for [Theoldreader's API](https://github.com/theoldreader/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'theoldreader-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install theoldreader-api
+
+## Usage
+
+### Authentication
+First you need to [obtain a token](https://github.com/theoldreader/api#authentication) for theoldreader user:
+
+```ruby
+
+require 'theoldreader-api'
+
+Theoldreader::Api.new.accounts_clientlogin(
+  Email: 'test@krasnoukhov.com', Passwd: '...', client: 'YourAppName'
+)
+=> {"SID"=>"none", "LSID"=>"none", "Auth"=>"LyTEJPvTJiSPrCxLu46d"}
+```
+
+With this token you have access to all other methods of Theoldreader's API.
+
+### Generic
+
+```ruby
+api = Theoldreader::Api.new("LyTEJPvTJiSPrCxLu46d")
+
+api.call!('get', '/reader/api/0/user-info', {output: 'json'})
+```
+
+`call!` will pass every option you provide directly to Theoldreader's Api.
+
+### Shortcut
+
+```ruby
+api.call('user-info')
+
+api.call('subscription/quickadd', quickadd: 'http://xkcd.com')
+
+api.call('tag/list')
+
+api.call('/reader/subscriptions/export')
+
+```
+
+`call` will filter your options to include only those listed in specification for the given endpoint.
+
+`call` accepts endpoints from `Theoldreader::Api::ENDPOINTS.keys` as its first 
+
+`Theoldreader::Api::ENDPOINTS` includes all available methods from Theoldreader's API (with 'reader/api/0/' being left out), except those three wich returns specific atom feeds (https://theoldreader.com/reader/atom/...). You can access them if you want with `call!`
+
+### Shortcuts for shortcuts
+
+If you mentally process your endpoint through `.downcase.sub(%r{^/+}, '').gsub(%r{[-/]}, '_')` you should also get available method for Api.
+
+```ruby
+# to get userinfo
+api.user_info
+
+# to add new feed
+api.subscription_quickadd(quickadd: 'http://xkcd.com')
+
+# to get the last two unread items
+api.stream_contents(
+  s: 'user/-/state/com.google/reading-list',
+  xt: 'user/-/state/com.google/read',
+  n: 2
+)
+```
+
+Works only for keys listed in `Theoldreader::Api::ENDPOINTS.keys`
+
+## Advanced Usage
+
+You can change [faraday](https://github.com/lostisland/faraday) adapter:
+
+```ruby
+require 'net/http/persistent'
+
+Theoldreader::Api.new('LyTEJPvTJiSPrCxLu46d', {adapter: :net_http_persistent})
+```
+
+And you can use API via http instead of https:
+
+```ruby
+Theoldreader::Api.new('LyTEJPvTJiSPrCxLu46d', {use_ssl: false})
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ilzoff/theoldreader-api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "theoldreader/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/theoldreader/api.rb

@@ -0,0 +1,144 @@
+require 'theoldreader/api/version'
+require 'faraday'
+require 'multi_json'
+
+module Theoldreader
+  class Api #:nodoc:
+    HOST = 'theoldreader.com'
+    BASE_PATH = '/reader/api/0/'
+    ENDPOINTS = {
+      'accounts/ClientLogin' => { method: 'post', params: %w(client Email Passwd), default_params: { accountType: 'HOSTED_OR_GOOGLE', service: 'reader' }},
+      'status' => { method: 'get' },
+      'token' => { method: 'get' },
+      'user-info' => { method: 'get' },
+      'preference/list' => { method: 'get' },
+      'friend/list' => { method: 'get' },
+      'friend/edit' => { method: 'post', params: %w(action u) },
+      'comment/edit' => { method: 'post', params: %w(action i comment) },
+      'tag/list' => { method: 'get' },
+      'preference/stream/list' => { method: 'get' },
+      'preference/stream/set' => { method: 'post' },
+      'rename-tag' => { method: 'post', params: %w(s dest) },
+      'disable-tag' => { method: 'post', params: %w(s) },
+      'unread-count' => { method: 'get' },
+      'subscription/list' => { method: 'get' },
+      'subscription/quickadd' => { method: 'post', params: %w(quickadd) },
+      'subscription/edit' => { method: 'post', params: %w(ac s t a r) },
+      'stream/items/ids' => { method: 'get', params: %w(s xt n r c nt ot) },
+      'stream/items/contents' => { method: 'post', params: %w(i output) },
+      'stream/contents' => { method: 'get', params: %w(s xt n r c nt ot output) },
+      'mark-all-as-read' => { method: 'post', params: %w(s ts) },
+      'edit-tag' => { method: 'post', params: %w(i a r annotation) },
+      '/reader/subscriptions/export' => { method: 'get', params: %w(output) }
+    }.freeze
+
+    attr_accessor :api_token, :http_options
+
+    def initialize(api_token = nil, http_options = {})
+      @api_token = api_token
+      @http_options = http_options
+    end
+
+    def call(endpoint, params = {}, headers = {})
+      guard_wrong_endpoint(endpoint)
+      call!(
+        ENDPOINTS[endpoint][:method], path(endpoint),
+        build_options(endpoint, params), headers
+      )
+    end
+
+    def call!(verb, endpoint, params = {}, headers = {})
+      response = conn.send(
+        verb, endpoint, params, auth_header.merge(headers)
+      )
+      handle_erros(response)
+      prepare_response(response)
+    end
+
+    ENDPOINTS.keys.each do |e|
+      method_name = e.downcase.sub(%r{^/+}, '').gsub(%r{[-/]}, '_').to_sym
+      define_method method_name do |*args|
+        call(e, *args)
+      end
+    end
+
+    private
+
+    def conn
+      @conn ||= Faraday.new(url: "#{protocol}://#{HOST}") do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter http_options[:adapter] || Faraday.default_adapter
+      end
+    end
+
+    def guard_wrong_endpoint(endpoint)
+      fail Exceptions::WrongEndpoint unless ENDPOINTS.keys.include?(endpoint)
+    end
+
+    def build_options(endpoint, params)
+      default_params(endpoint).merge(sanitize_params(endpoint, params))
+    end
+
+    def protocol
+      http_options[:use_ssl] == false ? 'http' : 'https'
+    end
+
+    def path(endpoint)
+      (endpoint.start_with?('/') ? '' : BASE_PATH) + endpoint
+    end
+
+    def default_params(endpoint)
+      { output: 'json' }.merge(ENDPOINTS[endpoint][:default_params] || {})
+    end
+
+    def sanitize_params(endpoint, params)
+      return {} unless ENDPOINTS[endpoint][:params]
+      params.delete_if do |key, _|
+        !ENDPOINTS[endpoint][:params].include?(key.to_s)
+      end
+    end
+
+    def handle_erros(response)
+      fail(
+        Exceptions::ResponseError.new(response),
+        'Theoldreader API has returned the error'
+      ) unless response.status == 200
+    end
+
+    def prepare_response(response)
+      MultiJson.load(response.body.to_s)
+    rescue MultiJson::LoadError
+      response.body
+    end
+
+    def auth_header
+      api_token.nil? ? {} : { 'Authorization' => "GoogleLogin auth=#{api_token}" }
+    end
+  end
+
+  module Exceptions
+    class ResponseError < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def to_s
+        super + format(' (%s)', data.map { |k, v| %(#{k}: "#{v}") }.join(', '))
+      end
+
+      private
+
+      def data
+        @data ||= begin
+          MultiJson.load(response.body)
+        rescue MultiJson::DecodeError
+          { uri: response.env.url.to_s, errors: response.body.to_s }
+        end.merge(code: response.status)
+      end
+    end
+    class WrongEndpoint < StandardError
+    end
+  end
+end

data/lib/theoldreader/api/version.rb

@@ -0,0 +1,5 @@
+module Theoldreader
+  class Api #:nodoc:
+    VERSION = '0.1.0'
+  end
+end

data/theoldreader-api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'theoldreader/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'theoldreader-api'
+  spec.version       = Theoldreader::Api::VERSION
+  spec.authors       = ['Ilia Zemskov']
+  spec.email         = ['il.zoff@gmail.com']
+
+  spec.summary       = "Ruby wrapper for Theoldreader's API"
+  spec.homepage      = 'https://github.com/ilzoff/theoldreader-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'multi_json'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: theoldreader-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilia Zemskov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- il.zoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/theoldreader/api.rb
+- lib/theoldreader/api/version.rb
+- theoldreader-api.gemspec
+homepage: https://github.com/ilzoff/theoldreader-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Theoldreader's API
+test_files: []