storify 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 488d1fb73f0c02593590f124002f103b0ed96fdd
-  data.tar.gz: 008e7f1650cd761627297de605f2fcfb94760e39
+  metadata.gz: 8e5b35c38cdddf4afe33c92a7e6881ffaa67204a
+  data.tar.gz: 8812500f6fd457cbab902acb867eb360594f211e
 SHA512:
-  metadata.gz: 7b5615dd1ca034c3478c3e41aed0e1f5508ec946c32b3abf58c57325dd3479806104278a9b02880ef00bf1f8a8c3fc56222efbbc54ffb4111e05b5dbd951b93d
-  data.tar.gz: d9db9630e971f4dca1cacf937fc2757fdc564a649d53c6f5430264573836ad5c858fb68ebbe5fc8d7b0d35d94d7a011c4413e09e2cc1267df706962995988f7a
+  metadata.gz: 5242d0dc6441c8f683fd1f29014454094c24b099921e40de4a12f15ca679bf9509ffa5ee1e3f77303acf249a064866142cfbcba4d2e65ef71bc48b048f8a3b09
+  data.tar.gz: 0ae3995e36650a02fdddc67945dc00a29b4fc801abad24c477b84587fe5b1d95fec541f8eefbe3742b1e37de709f8b4ebf342aaf3880e223f17c7cd2cd0513e0

data/lib/storify/client.rb

@@ -18,50 +18,51 @@ class Storify::Client
     self
   end
 
-  def userstories(username = @username, options: {})
+  def userstories(username = @username, pager: nil, options: {})
     endpoint = Storify::endpoint(version: options[:version],
                                  protocol: options[:protocol],
                                  method: :userstories,
                                  params: {':username' => username})
 
-    pager = add_pagination
+    pager = Storify::Pager.new unless pager.is_a?(Storify::Pager)
     stories = []
 
-    while data = call(endpoint, :GET, pager)
+    begin
+      data = call(endpoint, :GET, pager.to_hash)
       content = data['content']
-      break if content['stories'].length == 0
 
       content['stories'].each do |s|
         stories << Storify::Story.new(s)
       end
 
-      pager[:page] += 1
-    end
+      pager.next
+    end while pager.has_pages?(content['stories'])
 
     stories
   end
 
-  def story(slug, username = @username, options: {})
+  def story(slug, username = @username, pager: nil, options: {})
     params = {':username' => username, ':slug' => slug}
     endpoint = Storify::endpoint(version: options[:version],
                                  protocol: options[:protocol],
                                  method: :userstory,
                                  params: params)
-    pager = add_pagination
+
+    pager = Storify::Pager.new unless pager.is_a?(Storify::Pager)
     story = nil
     elements = []
 
-    while data = call(endpoint, :GET, pager)
+    begin
+      data = call(endpoint, :GET, pager.to_hash)
       story = Storify::Story.new(data['content']) if story.nil?
-      break if data['content']['elements'].length == 0
 
       # create elements
       data['content']['elements'].each do |e|
         story.add_element(Storify::Element.new(e))
       end
 
-      pager[:page] += 1
-    end
+      pager.next
+    end while pager.has_pages?(data['content']['elements'])
 
     story
   end
@@ -70,13 +71,6 @@ class Storify::Client
     !@token.nil?
   end
 
-  def add_pagination(page = 1, per_page = 20)
-    params = {}
-    params[:page] = page
-    params[:per_page] = per_page
-    params
-  end
-
 
   private
 

data/lib/storify/pager.rb

@@ -0,0 +1,46 @@
+class Storify::Pager
+  MIN_PAGE = 1
+  MAX_PER_PAGE = 50
+
+  attr_reader :page, :per_page, :max
+
+  def initialize(page: 1, per_page: 20, max: 0)
+    @max = max.to_i.abs
+    self.page=(page)
+    self.per_page=(per_page)
+  end
+
+  def per_page=(value)
+    @per_page = (value > MAX_PER_PAGE) ? MAX_PER_PAGE : value.to_i.abs
+  end
+
+  def next
+    self.page=(@page + 1)
+    self
+  end
+
+  def prev
+    self.page=(@page - 1)
+    self
+  end
+
+  def to_hash
+    {:page => @page, :per_page => @per_page}
+  end
+
+  def has_pages?(array = [])
+    return false unless array.is_a?(Array)
+    return false if (@page > @max && @max != 0)
+
+    array.length != 0
+  end
+
+  private
+
+  def page=(value)
+    return @page = MIN_PAGE if (value < MIN_PAGE)
+    return @page = (@max + 1) if ((value > @max) && @max != 0)
+
+    @page = value.to_i
+  end
+end

data/lib/storify.rb

@@ -30,5 +30,6 @@ end
 
 require 'storify/story'
 require 'storify/client'
+require 'storify/pager'
 require 'storify/element'
-require 'storify/apierror'
+require 'storify/apierror'

data/spec/client_spec.rb

@@ -18,6 +18,12 @@ describe Storify::Client do
       options = {:version => :v1, :protocol => :insecure}
       @client.userstories(@username, options: options).length.should == 2
     end
+
+    it "should accept paging options (Pager)" do
+      pager = Storify::Pager.new(page: 1, max: 1, per_page: 10)
+      stories = @client.userstories('joshuabaer', pager: pager)
+      stories.length.should == 10
+    end
   end
 
   context "GET /stories/:username/:slug" do
@@ -29,11 +35,18 @@ describe Storify::Client do
       options = {:version => :v1, :protocol => :insecure}
       @client.story(@story, options: options).elements.length.should == 3
     end
+
+    it "should accept paging options (Page)" do
+      pager = Storify::Pager.new(page: 2, max: 3)
+      story = @client.story('austin-startup-digest-for-december-9-2014', 'joshuabaer', pager: pager)
+      story = story.to_s
+
+      ['408651138632667136', '409182832234213376'].each {|s| story.include?(s).should be_true }
+     end
   end
 
   it "should allow a story to be serialized as text" do
     story = @client.story('austin-startup-digest-for-december-9-2014', 'joshuabaer')
     story.should_not eql ""
-    puts story.to_s
   end
 end

data/spec/pager_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Storify::Pager do
+  context "Page" do
+    it "should optionally accept a starting page" do
+      Storify::Pager.new(page: 10).page.should == 10
+    end
+
+    it "should set the default starting page to 1" do
+      Storify::Pager.new.page.should == 1
+    end
+
+    it "should limit the page to the API Min" do
+      pager = Storify::Pager.new(page: -1)
+      pager.page.should == Storify::Pager::MIN_PAGE
+    end
+
+    it "should optionally allow an artificial max page (inclusive)" do
+      pager = Storify::Pager.new(max: 20)
+      pager.max.should == 20
+    end
+
+    it "should default the page max to unlimited (0)" do
+      pager = Storify::Pager.new
+      pager.max.should == 0
+    end
+
+    it "should allow a page to be advanced (forward)" do
+      pager = Storify::Pager.new
+      pager.next.page.should == 2
+    end
+
+    it "should not allow a page to be advanced beyond (max + 1)" do
+      pager = Storify::Pager.new(max: 2)
+      pager.next.next.next.page.should == 3
+    end
+
+    it "should allow a page to be advanced (backward)" do
+      pager = Storify::Pager.new(page: 2)
+      pager.prev.prev.page.should == 1
+    end
+  end
+
+  context "Per Page" do
+    it "should optionally accept a per page option" do
+      Storify::Pager.new(per_page: 15).per_page.should == 15
+    end
+
+    it "should set the default per_page to 20" do
+      Storify::Pager.new.per_page.should == 20
+    end
+
+    it "should limit per_page to the API Max" do
+      # Constructor
+      pager = Storify::Pager.new(per_page: 100)
+      pager.per_page.should == Storify::Pager::MAX_PER_PAGE
+
+      # Setter
+      pager.per_page = 500
+      pager.per_page.should == Storify::Pager::MAX_PER_PAGE
+    end
+  end
+
+  context "Utility" do
+    it "should provide access to pagnination as a parameter hash" do
+      pager = Storify::Pager.new(page: 13, per_page: 25).to_hash
+      pager[:page].should == 13
+      pager[:per_page].should == 25
+    end
+
+    it "should know if there are pages left based on content array size" do
+      data = {'content' => {'stories' => ['s1', 's2', 's3']}}
+      pager = Storify::Pager.new
+      pager.has_pages?(data['content']['stories']).should be_true
+      pager.has_pages?(data['content'][:invalid]).should be_false
+      pager.has_pages?([]).should be_false
+    end
+
+    it "should have no pages left once on the final page" do
+      pager = Storify::Pager.new(max: 2)
+      pager.next.next.next
+      pager.has_pages?(['g']).should be_false
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storify
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Rizwan Tejpar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -89,10 +89,12 @@ files:
 - lib/storify/apierror.rb
 - lib/storify/client.rb
 - lib/storify/element.rb
+- lib/storify/pager.rb
 - lib/storify/story.rb
 - lib/storify.rb
 - spec/client_auth_spec.rb
 - spec/client_spec.rb
+- spec/pager_spec.rb
 - spec/spec_helper.rb
 - spec/storify_spec.rb
 homepage: https://github.com/natural-affinity/storify
@@ -122,5 +124,6 @@ summary: Storify API
 test_files:
 - spec/client_auth_spec.rb
 - spec/client_spec.rb
+- spec/pager_spec.rb
 - spec/spec_helper.rb
 - spec/storify_spec.rb