disqus_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 133d31109b75e6a7a8a3948ae883667b419c9d41
-  data.tar.gz: 2316f34bd676de9379991a8f5f260db9fe17307b
+  metadata.gz: 86c8f27e2bb06b2355b45fc73a69d07b830d0372
+  data.tar.gz: df17c1bb6520a90fed6963c6cf873c9bddc5ce11
 SHA512:
-  metadata.gz: b7c188e126d73f1f8b4a4b2f7b07fbd872ce6552d0f26b55d5ae2349b86906c54bbb7dfd06b3737380a7b695e862a8f7dd416b6dcba7db499312ff3dabc57ab0
-  data.tar.gz: 4b45529a2925f8cfd95e82b8e760c5d03ec4036995af60d06aaf999eb6613fe2825077e40301a6b7861fb9de31972d2de7c02194fd9bd1dabf2e301bea83dcd7
+  metadata.gz: 23ade579f2fcb9b142bcb539d85278b4d6aebaf726bc3030fbb5e9d58614bffbaa10660c446b30612ad02cce225df498f51f45cec6427b383f5719a62075a8fe
+  data.tar.gz: eb1169533ebe20d233c132177f418ccc3dee21742af4a698848dc20e8e839f319dd6a1cef14d7b429682cb52e53e27abe07d83e7806cf4cf90cacff8b8c236a7

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,9 +1,11 @@
 # Disqus API for Ruby
 [![Gem Version](https://badge.fury.io/rb/disqus_api.png)](http://badge.fury.io/rb/disqus_api)
-[![Build Status](https://travis-ci.org/einzige/disqus_api.png?branch=master)](https://travis-ci.org/einzige/disqus_api)
+[![Build Status](https://travis-ci.org/toptal/disqus_api.png?branch=master)](https://travis-ci.org/toptal/disqus_api)
 
 Provides clean Disqus REST API for your Ruby app. Currently supported API version: 3.0.
 
+See also [Disqus API for Rails](https://github.com/toptal/disqus_api_rails).
+
 ## Install
 
 ```bash
@@ -13,6 +15,8 @@ gem install disqus_api
 ## Configure
 
 ```ruby
+require 'disqus_api'
+
 DisqusApi.config = {api_secret: 'secret key',
                     api_key: 'public key',
                     access_token: 'token from app settings'}
@@ -68,14 +72,48 @@ DisqusApi.v3.posts.list(forum: 'my_form').all
 
 ### Pagination
 
+Step by step:
+
 ```ruby
 first_page  = DisqusApi.v3.posts.list(forum: 'my_forum', limit: 10)
 
 second_page = first_page.next
 third_page  = second_page.next
+first_page  = thrid_page.prev.prev
 # ...
 ```
 
+It is useful to go through all records. This way you will pass every page in batches by 10:
+
+```ruby
+DisqusApi.v3.posts.list(limit: 10).each_resource do |comment|
+  puts comment.inspect
+end
+```
+
+You can also iterate collection page by page.
+
+```ruby
+DisqusApi.v3.posts.each_page do |comments|
+  comments.each do |comment|
+    puts comment.inspect
+  end
+end
+```
+
+You can also move on next page:
+
+```ruby
+response = DisqusApi.v3.posts
+response.next!
+```
+
+Or on previous one:
+
+```ruby
+response.prev!
+```
+
 ### Performing custom requests
 
 ```ruby
@@ -83,18 +121,29 @@ DisqusApi.v3.get('posts/list.json', forum: 'my_forum')
 DisqusApi.v3.post('posts/create.json', forum: 'my_forum')
 ```
 
-### Using in test environment
+### Handling exceptions
 
-Disqus API uses Faraday gem, refer to its documentation for details.
+Just catch `DisqusApi::InvalidApiRequestError`. It has `code` to identify problems with a request.
+
+```ruby
+begin
+  DisqusApi.v3.posts.list(forum: 'something-wrong')
+rescue DisqusApi::InvalidApiRequestError => e
+  e.response.inspect
+end
+
+#=> {"code"=>2, "response"=>"Invalid argument, 'forum': Unable to find forum 'something-wrong'"}
+```
+
+### Using in test environment
 
 ```ruby
 before :all do
   # You can move this block in RSpec initializer or `spec_helper.rb`
 
-  stubbed_request = Faraday::Adapter::Test::Stubs.new do |stub|
+  DisqusApi.stub_requests do |stub|
     stub.get('/api/3.0/users/details.json') { [200, {}, {code: 0, body: {response: :whatever}}.to_json] }
   end
-  DisqusApi.adapter = [:test, stubbed_requests]
 end
 
 it 'performs requests' do
@@ -102,6 +151,28 @@ it 'performs requests' do
 end
 ```
 
+Disqus API uses Faraday gem, refer to its documentation for details.
+
+### Running specs
+
+Use any of the following commands from the project directory:
+
+```bash
+rspec
+```
+
+```ruby
+rake # rake gem must be installed
+```
+
+In order to test on a real Discus account
+- specify `spec/config/disqus.yml` (see `spec/config/disqus.yml.example` for details)
+- run specs passing `USE_DISQUS_ACCOUNT` environment variable:
+
+```bash
+USE_DISQUS_ACCOUNT=1 rspec
+```
+
 ## Contributing to disqus_api
 
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/disqus_api.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{disqus_api}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.date = %q{2013-12-09}
-  s.authors = ["Sergei Zinin"]
+  s.authors = ["Sergei Zinin (einzige)"]
   s.email = %q{szinin@gmail.com}
-  s.homepage = %q{http://github.com/einzige/disqus_api}
+  s.homepage = %q{http://github.com/toptal/disqus_api}
 
   s.licenses = ["MIT"]
 
@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport', ">= 3.0.0"
   s.add_runtime_dependency 'faraday', ">= 0.8"
   s.add_runtime_dependency 'faraday_middleware', ">= 0.9"
-  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rspec'
 end
 

data/lib/disqus_api.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/object/try'
 require 'yaml'
 require 'json'
@@ -9,8 +10,10 @@ require 'disqus_api/api'
 require 'disqus_api/namespace'
 require 'disqus_api/request'
 require 'disqus_api/response'
+require 'disqus_api/invalid_api_request_error'
 
 module DisqusApi
+  VERSION = '0.0.3'
 
   def self.adapter
     @adapter || Faraday.default_adapter
@@ -22,7 +25,7 @@ module DisqusApi
 
   # @return [ActiveSupport::HashWithIndifferentAccess]
   def self.config
-    @config || raise("No configuration specified for Disqus")
+    @config || {}
   end
 
   # @param [Hash] config
@@ -39,6 +42,11 @@ module DisqusApi
     Api.new(version, YAML.load_file(File.join(File.dirname(__FILE__), "apis/#{version}.yml")))
   end
 
+  def self.stub_requests(&block)
+    stubbed_requests = Faraday::Adapter::Test::Stubs.new(&block)
+    DisqusApi.adapter = [:test, stubbed_requests]
+  end
+
   # @return [Api]
   def self.v3
     @v3 ||= init('3.0')

data/lib/disqus_api/api.rb

@@ -1,10 +1,4 @@
 module DisqusApi
-  class InvalidApiRequestError < Exception
-    def initialize(response, message = response.inspect)
-      super(response)
-    end
-  end
-
   class Api
     DEFAULT_VERSION = '3.0'
     attr_reader :version, :endpoint, :specifications, :namespaces
@@ -38,7 +32,7 @@ module DisqusApi
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Response::ParseJson
 
-        builder.params.merge!(DisqusApi.config)
+        builder.params.merge!(DisqusApi.config.slice(:api_secret, :api_key, :access_token))
 
         builder.adapter(*DisqusApi.adapter)
       end

data/lib/disqus_api/invalid_api_request_error.rb

@@ -0,0 +1,13 @@
+module DisqusApi
+  class InvalidApiRequestError < StandardError
+    attr_reader :response
+
+    # @param [Hash] response
+    # @param [Stirng] message
+    def initialize(response, message = response.inspect)
+      @response = response
+      super(message)
+    end
+  end
+end
+

data/lib/disqus_api/request.rb

@@ -2,7 +2,7 @@ module DisqusApi
   class Request
     attr_reader :api, :path, :namespace, :action, :arguments, :type
 
-    # @param [Class<DisqusApi::Api>] api
+    # @param [DisqusApi::Api] api
     # @param [String] namespace
     # @param [String] action
     # @param [Hash] arguments Request parameters

data/lib/disqus_api/response.rb

@@ -12,17 +12,43 @@ module DisqusApi
       super(@content)
     end
 
-    # Fetches all records going through pagination
+    # Fetches all response collection entries going through pagination
     # @return [Array<Hash>]
     def all
-      [].tap do |result|
+      each_resource.to_a
+    end
+
+    # Iterates through each response entry through all pages
+    # @return [Enumerator<Hash>]
+    def each_resource(&block)
+      Enumerator.new do |result|
+        each_page { |resources| resources.each { |resource| result << resource } }
+      end.each(&block)
+    end
+
+    # Iterates through every single page
+    # @return [Enumerator<Array<Hash>>]
+    def each_page(&block)
+      Enumerator.new do |result|
         next_response = self
 
         while next_response
-          result.concat(next_response.body)
+          result << next_response.body.to_a
           next_response = next_response.next
         end
-      end
+      end.each(&block)
+    end
+
+    # @return [Response]
+    def next!
+      self.merge!(self.next) if has_next?
+      self
+    end
+
+    # @return [Response]
+    def prev!
+      self.merge!(self.prev) if has_prev?
+      self
     end
 
     # @return [Response, nil]
@@ -32,15 +58,31 @@ module DisqusApi
       end
     end
 
+    # @return [Response, nil]
+    def prev
+      if has_prev?
+        request.response(arguments.merge(cursor: prev_cursor))
+      end
+    end
+
     def has_next?
       self['cursor']['hasNext']
     end
 
+    def has_prev?
+      self['cursor']['hasPrev']
+    end
+
     # @return [String]
     def next_cursor
       self['cursor']['next']
     end
 
+    # @return [String]
+    def prev_cursor
+      self['cursor']['prev']
+    end
+
     # @return [Hash]
     def body
       self['response']

data/spec/disqus_api/response_spec.rb

@@ -29,11 +29,28 @@ describe DisqusApi::Response do
     end
   end
 
+  describe "#has_prev?" do
+    context "has" do
+      let(:response_body) { {'cursor' => {'hasPrev' => true}} }
+      its(:has_prev?) { should be_true }
+    end
+
+    context 'has not' do
+      let(:response_body) { {'cursor' => {'hasPrev' => false}} }
+      its(:has_prev?) { should be_false }
+    end
+  end
+
   describe "#next_cursor" do
     let(:response_body) { {'cursor' => {'next' => 'next identifier'}} }
     its(:next_cursor) { should == 'next identifier' }
   end
 
+  describe "#prev_cursor" do
+    let(:response_body) { {'cursor' => {'prev' => 'prev identifier'}} }
+    its(:prev_cursor) { should == 'prev identifier' }
+  end
+
   describe "#body" do
     let(:response_body) { {'response' => {'received' => true}} }
     its(:body) { should == {'received' => true} }
@@ -46,37 +63,144 @@ describe DisqusApi::Response do
 
   describe "#next" do
     context "has next page" do
-      let(:response_body) { {'cursor' => {'hasNext' => true, 'next' => 'Next:2'}} }
+      let(:response_body) { {'cursor' => {'hasNext' => true, 'next' => 'another_page'}} }
       let(:next_page_response) { double('next_page_response') }
 
       before do
-        request.should_receive(:response).with({limit: 1, cursor: 'Next:2'}).and_return(next_page_response)
+        request.should_receive(:response).with({limit: 1, cursor: 'another_page'}).and_return(next_page_response)
       end
 
       its(:next) { should == next_page_response }
     end
 
     context 'has no next page' do
-      let(:response_body) { {'cursor' => {'hasNext' => false, 'next' => 'Next:2'}} }
+      let(:response_body) { {'cursor' => {'hasNext' => false, 'next' => 'another_page'}} }
       its(:next) { should be_nil }
     end
   end
 
-  describe "#all" do
-    let(:response_body) { {'cursor' => {'hasNext' => false, 'next' => 'Next:2'}, 'response' => ['page_1_elem_1']} }
-    its(:all) { should == ['page_1_elem_1'] }
+  describe "#next" do
+    context "has previous page" do
+      let(:response_body) { {'cursor' => {'hasPrev' => true, 'prev' => 'another_page'}} }
+      let(:prev_page_response) { double('prev_page_response') }
 
-    context "many pages" do
-      let(:response_body) { {'cursor' => {'hasNext' => true, 'next' => 'Next:2'}, 'response' => ['page_1_elem_1']} }
-      let(:next_page_response) { double('next_page_response') }
+      before do
+        request.should_receive(:response).with({limit: 1, cursor: 'another_page'}).and_return(prev_page_response)
+      end
+
+      its(:prev) { should == prev_page_response }
+    end
+
+    context 'has no prev page' do
+      let(:response_body) { {'cursor' => {'hasPrev' => false, 'prev' => 'another_page'}} }
+      its(:prev) { should be_nil }
+    end
+  end
 
+  describe "pagination" do
+    its(:each_page) { should be_a(Enumerator) }
+
+    context "building a enumerator" do
       before do
-        request.should_receive(:response).with({limit: 1, cursor: 'Next:2'}).and_return(next_page_response)
-        next_page_response.should_receive(:body).and_return(['page_2_elem_1'])
-        next_page_response.should_receive(:next).and_return(nil)
+        request.should_not_receive(:next)
+        request.should_not_receive(:perform)
+      end
+
+      describe "#each_page" do
+        it 'acts as iterator' do
+          subject.each_page
+        end
       end
 
-      its(:all) { should == ['page_1_elem_1', 'page_2_elem_1'] }
+      describe "#each_resource" do
+        it 'acts as iterator' do
+          subject.each_resource
+        end
+      end
+    end
+
+    context "multiple pages" do
+      before do
+        request.should_receive(:perform).with(arguments.merge(cursor: 'another_page')).and_return(another_page_response_body)
+      end
+
+      let(:page_1_elem_1) { double('page_1_elem_1') }
+      let(:page_2_elem_1) { double('page_2_elem_1') }
+
+      let(:response_body) {
+        {'cursor' => {'hasNext' => true, 'next' => 'another_page'}, 'page' => 1, 'response' => [page_1_elem_1]}
+      }
+      let(:another_page_response_body) {
+        {'cursor' => {'hasNext' => false}, 'page' => 2, 'response' => [page_2_elem_1]}
+      }
+      its(:all) { should == [page_1_elem_1, page_2_elem_1] }
+
+      describe "#next!" do
+        before { response.next! }
+        it { should be_a(described_class) }
+
+        it 'steps on next page' do
+          response['page'].should == 2
+        end
+
+        context "no next" do
+          before { response.next! }
+
+          it 'does nothing' do
+            response['page'].should == 2
+          end
+        end
+      end
+
+      describe "#prev!" do
+        let(:response_body) {
+          {'cursor' => {'hasPrev' => true, 'prev' => 'another_page'}, 'page' => 2}
+        }
+        let(:another_page_response_body) {
+          {'cursor' => {'hasPrev' => false}, 'page' => 1}
+        }
+
+        before { response.prev! }
+        it { should be_a(described_class) }
+
+        it 'steps on previous page' do
+          response['page'].should == 1
+        end
+
+        context "no previous" do
+          before { response.prev! }
+
+          it 'does nothing' do
+            response['page'].should == 1
+          end
+        end
+      end
+
+      describe "#each_page" do
+        it 'returns each page' do
+          subject.each_page.to_a.should == [[page_1_elem_1], [page_2_elem_1]]
+        end
+
+        it 'iterates through each page' do
+          page_1_elem_1.should_receive(:get_block_message)
+          page_2_elem_1.should_receive(:get_block_message)
+
+          subject.each_page { |page| page.each(&:get_block_message) }
+        end
+      end
+
+      describe "#each_resource" do
+        it 'returns each record iterator' do
+          subject.each_resource.to_a.should == [page_1_elem_1, page_2_elem_1]
+        end
+
+        it 'iterates through each resource' do
+          page_1_elem_1.should_receive(:get_block_message)
+          page_2_elem_1.should_receive(:get_block_message)
+
+          subject.each_resource(&:get_block_message)
+        end
+      end
     end
   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: disqus_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- Sergei Zinin
+- Sergei Zinin (einzige)
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -76,12 +76,14 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - disqus_api.gemspec
 - lib/apis/3.0.yml
 - lib/disqus_api.rb
 - lib/disqus_api/api.rb
+- lib/disqus_api/invalid_api_request_error.rb
 - lib/disqus_api/namespace.rb
 - lib/disqus_api/request.rb
 - lib/disqus_api/response.rb
@@ -92,7 +94,7 @@ files:
 - spec/disqus_api/response_spec.rb
 - spec/disqus_api_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/einzige/disqus_api
+homepage: http://github.com/toptal/disqus_api
 licenses:
 - MIT
 metadata: {}