storify 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e5b35c38cdddf4afe33c92a7e6881ffaa67204a
-  data.tar.gz: 8812500f6fd457cbab902acb867eb360594f211e
+  metadata.gz: ee651fbc8ced627f9d5711d772ac0d998c4cea5f
+  data.tar.gz: de03b76abd522d5992ac684e6446222a299bf2cc
 SHA512:
-  metadata.gz: 5242d0dc6441c8f683fd1f29014454094c24b099921e40de4a12f15ca679bf9509ffa5ee1e3f77303acf249a064866142cfbcba4d2e65ef71bc48b048f8a3b09
-  data.tar.gz: 0ae3995e36650a02fdddc67945dc00a29b4fc801abad24c477b84587fe5b1d95fec541f8eefbe3742b1e37de709f8b4ebf342aaf3880e223f17c7cd2cd0513e0
+  metadata.gz: b15afc86cbfda8cda37ca17da233df0b68065e8f0f107f445fc8f495747e77fa3fd49de10ef21629729460b3c372ea24da2074d2fea2e8f420442ec969e38dd0
+  data.tar.gz: ca3fff59c7a87850892817b60603dfbb26663a8516a1a0806d7b8b887a81d1eca198656dc5bff6f94f39aafbcc3508f9bb5d35dfdfad8f48509a40c0adb31096

data/lib/storify/apierror.rb

@@ -1,13 +1,15 @@
-class Storify::ApiError < StandardError
-  attr_reader :status, :type, :message
+module Storify
+  class ApiError < StandardError
+    attr_reader :status, :type, :message
 
-  def initialize(status, message, type = nil)
-    @type = type
-    @status = status
-    @message = message
-  end
+    def initialize(status, message, type = nil)
+      @type = type
+      @status = status
+      @message = message
+    end
 
-  def to_s
-    "#{self.status} #{self.type} #{self.message}"
+    def to_s
+      "#{self.status} #{self.type} #{self.message}"
+    end
   end
 end

data/lib/storify/client.rb

@@ -2,101 +2,128 @@ require 'json'
 require 'rest-client'
 #RestClient.log = './restclient.log'
 
-class Storify::Client
-  attr_reader :api_key, :username, :token
+module Storify
+  class Client
+    # define end of content example
+    EOC = {'content' => {'stories' => [], 'elements' => []}}
 
-  def initialize(api_key, username)
-    @api_key = api_key
-    @username = username
-  end
+    attr_reader :api_key, :username, :token
 
-  def auth(password, options: {})
-    endpoint = Storify::endpoint(version: options[:version], method: :auth)
-    data = call(endpoint, :POST, {password: password})
-    @token = data['content']['_token']
+    def initialize(api_key, username)
+      @api_key = api_key
+      @username = username
+    end
 
-    self
-  end
+    def auth(password, options: {})
+      endpoint = Storify::endpoint(version: options[:version], method: :auth)
+      data = call(endpoint, :POST, params: {password: password})
+      @token = data['content']['_token']
 
-  def userstories(username = @username, pager: nil, options: {})
-    endpoint = Storify::endpoint(version: options[:version],
-                                 protocol: options[:protocol],
-                                 method: :userstories,
-                                 params: {':username' => username})
+      self
+    end
 
-    pager = Storify::Pager.new unless pager.is_a?(Storify::Pager)
-    stories = []
+    def stories(pager: nil, options: {})
+      story_list(:stories, pager, options: options, use_auth: false)
+    end
 
-    begin
-      data = call(endpoint, :GET, pager.to_hash)
-      content = data['content']
+    def latest(pager: nil, options: {})
+      story_list(:latest, pager, options: options, use_auth: false)
+    end
 
-      content['stories'].each do |s|
-        stories << Storify::Story.new(s)
-      end
+    def featured(pager: nil, options: {})
+      story_list(:featured, pager, options: options, use_auth: false)
+    end
 
-      pager.next
-    end while pager.has_pages?(content['stories'])
+    def popular(pager: nil, options: {})
+      story_list(:popular, pager, options: options, use_auth: false)
+    end
 
-    stories
-  end
+    def userstories(username = @username, pager: nil, options: {})
+      params = {':username' => username}
+      story_list(:userstories, pager, options: options, params: params)
+    end
 
-  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)
+    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 = Storify::Pager.new unless pager.is_a?(Storify::Pager)
-    story = nil
-    elements = []
+      pager = pager ||= Pager.new
 
-    begin
-      data = call(endpoint, :GET, pager.to_hash)
-      story = Storify::Story.new(data['content']) if story.nil?
+      story = nil
+      elements = []
 
-      # create elements
-      data['content']['elements'].each do |e|
-        story.add_element(Storify::Element.new(e))
-      end
+      begin
+        data = call(endpoint, :GET, paging: pager.to_hash)
+        story = Story.new(data['content']) if story.nil?
 
-      pager.next
-    end while pager.has_pages?(data['content']['elements'])
+        # create elements
+        data['content']['elements'].each do |e|
+          story.add_element(Element.new(e))
+        end
 
-    story
-  end
+        pager.next
+      end while pager.has_pages?(data['content']['elements'])
 
-  def authenticated
-    !@token.nil?
-  end
+      story
+    end
 
+    def authenticated
+      !@token.nil?
+    end
 
-  private
 
-  def call(endpoint, verb, params = {}, opts = {})
-    raw = nil
+    private
 
-    begin
-      # inject auth params automatically (if available)
-      params[:username] = @username
-      params[:api_key] = @api_key
-      params[:_token] = @token if authenticated
+    def story_list(method, pager, params: {}, options: {}, use_auth: true)
+      endpoint = Storify::endpoint(version: options[:version],
+                                   protocol: options[:protocol],
+                                   method: method,
+                                   params: params)
 
-      case verb
-      when :POST
-        raw = RestClient.post endpoint, params, {:accept => :json}
-      when :GET
-        raw = RestClient.get endpoint, {:params => params}
-      end
-    rescue => e
-      raw = e.response
+      pager = pager ||= Pager.new
+      stories = []
+
+      begin
+        data = call(endpoint, :GET, paging: pager.to_hash, use_auth: use_auth)
+        content = data['content']
 
-      data = JSON.parse(e.response)
-      error = data['error']
-      raise Storify::ApiError.new(data['code'], error['message'], error['type'])
+        content['stories'].each do |s|
+          stories << Story.new(s)
+        end
+
+        pager.next
+      end while pager.has_pages?(content['stories'])
+
+      stories
     end
 
-    JSON.parse(raw)
+    def call(endpoint, verb, params: {}, paging: {}, opts: {}, use_auth: true)
+      raw = nil
+
+      begin
+        # add paging and auth query params
+        params.merge!(paging)
+        params[:username] = @username
+        params[:api_key] = @api_key
+        params[:_token] = @token if (authenticated && use_auth)
+
+        case verb
+        when :POST
+          raw = RestClient.post endpoint, params, {:accept => :json}
+        when :GET
+          raw = RestClient.get endpoint, {:params => params}
+        end
+      rescue => e
+        data = JSON.parse(e.response)
+        error = data['error']
+
+        return Storify::error(data['code'], error['message'], error['type'], end_of_content: EOC)
+      end
+
+      JSON.parse(raw)
+    end
   end
 end

data/lib/storify/element.rb

@@ -2,51 +2,53 @@ require 'date'
 require 'nokogiri'
 
 # todo: split logic into separate source types
-class Storify::Element
-  attr_reader :type, :source, :link, :published, :author
-  attr_accessor :desc
-
-  def initialize(content)
-    @type = content['type']
-    @source = content['source']['name']
-    @link = content['permalink']
-    @published = DateTime.parse(content['posted_at'])
-    
-    case @type
-    when 'image'
-      @desc = content['data'][@type]['caption']
-      
-      if content['data'].has_key?('oembed')
-        @author = content['data']['oembed']['author_name']
+module Storify
+  class Storify::Element
+    attr_reader :type, :source, :link, :published, :author
+    attr_accessor :desc
+
+    def initialize(content)
+      @type = content['type']
+      @source = content['source']['name']
+      @link = content['permalink']
+      @published = DateTime.parse(content['posted_at'])
+
+      case @type
+      when 'image'
+        @desc = content['data'][@type]['caption']
+
+        if content['data'].has_key?('oembed')
+          @author = content['data']['oembed']['author_name']
+        else
+          @author = content['attribution']['name']
+        end
+      when 'text'
+        @desc = content['data']['text']
+
+        doc = Nokogiri::HTML(@desc)
+        @desc = doc.xpath("//text()").to_s
       else
-        @author = content['attribution']['name']
+        @desc = content['data'][@type]['description']
+        @author = content['source']['username']
+        @author = "@" + @author if @source.downcase == 'twitter'
       end
-    when 'text'
-      @desc = content['data']['text']
-
-      doc = Nokogiri::HTML(@desc)
-      @desc = doc.xpath("//text()").to_s
-    else
-      @desc = content['data'][@type]['description']
-      @author = content['source']['username']
-      @author = "@" + @author if @source.downcase == 'twitter'
     end
-  end
 
-  def to_s
-    out = ''
+    def to_s
+      out = ''
+      published = @published.to_date
 
-    case @source.downcase
-    when 'storify'
-      out << "\n#{@desc}\n"
-      out << ('-' * @desc.length) + "\n\n" if @desc.length < 50 
-    when 'twitter'
-      out << "[#{@published.to_date.to_s}] #{@author}: #{@link}\n"
-    else
+      case @source.downcase
+      when 'storify'
+        out << "\n#{@desc}\n"
+        out << ('-' * @desc.length) + "\n\n" if @desc.length < 50
+      when 'twitter'
+        out << "[#{@published.to_s}] #{@author}: #{@link}\n"
+      else
+        out << "#{@author} [#{@published.to_s}]: #{@link}\n"
+      end
 
-      out << "#{@author} [#{@published.to_date.to_s}]: #{@link}\n"   
+      out
     end
-
-    out
   end
 end

data/lib/storify/pager.rb

@@ -1,46 +1,48 @@
-class Storify::Pager
-  MIN_PAGE = 1
-  MAX_PER_PAGE = 50
+module Storify
+  class Pager
+    MIN_PAGE = 1
+    MAX_PER_PAGE = 50
 
-  attr_reader :page, :per_page, :max
+    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 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 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 next
+      self.page=(@page + 1)
+      self
+    end
 
-  def prev
-    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 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)
+    def has_pages?(array = [])
+      return false unless array.is_a?(Array)
+      return false if (@page > @max && @max != 0)
 
-    array.length != 0
-  end
+      array.length != 0
+    end
 
-  private
+    private
 
-  def page=(value)
-    return @page = MIN_PAGE if (value < MIN_PAGE)
-    return @page = (@max + 1) if ((value > @max) && @max != 0)
+    def page=(value)
+      return @page = MIN_PAGE if (value < MIN_PAGE)
+      return @page = (@max + 1) if ((value > @max) && @max != 0)
 
-    @page = value.to_i
+      @page = value.to_i
+    end
   end
 end

data/lib/storify/story.rb

@@ -1,39 +1,41 @@
 require 'date'
 
-class Storify::Story
-  attr_reader :slug, :title, :desc, :link, :published, :author, :elements
-
-  def initialize(content)
-    @slug = content['slug']
-    @title = content['title']
-    @desc = content['description']
-    @link = content['permalink']
-    @author = content['author']['username']
-
-    unless content['date']['published'].nil?
-      @published = DateTime.parse(content['date']['published'])
+module Storify
+  class Story
+    attr_reader :slug, :title, :desc, :link, :published, :author, :elements
+
+    def initialize(content)
+      @slug = content['slug']
+      @title = content['title']
+      @desc = content['description']
+      @link = content['permalink']
+      @author = content['author']['username']
+
+      unless content['date']['published'].nil?
+        @published = DateTime.parse(content['date']['published'])
+      end
+
+      @elements = []
     end
 
-    @elements = []
-  end
-
-  def add_element(element)
-    @elements << element
-  end
+    def add_element(element)
+      @elements << element
+    end
 
-  def to_s
-    published = @published.nil? ? 'unpublished' : @published.to_date.to_s
+    def to_s
+      published = @published.nil? ? 'unpublished' : @published.to_date
 
-    out = "\n#{@title}\n"
-    out << ('-' * @title.length.to_i) + "\n"
-    out << "Date: #{published}\n"
-    out << "Author: #{@author}\n"
-    out << "Link: #{@link}\n"
-    out << "\n#{@desc} \n"
+      out = "\n#{@title}\n"
+      out << ('-' * @title.length.to_i) + "\n"
+      out << "Date: #{published.to_s}\n"
+      out << "Author: #{@author}\n"
+      out << "Link: #{@link}\n"
+      out << "\n#{@desc} \n"
 
-    # serialize elements
-    elements.each {|e| out << e.to_s }
+      # serialize elements
+      elements.each {|e| out << e.to_s }
 
-    out
+      out
+    end
   end
 end

data/lib/storify.rb

@@ -8,8 +8,12 @@ module Storify
     :v1 => {
       :base => 'api.storify.com/v1',
       :auth => '/auth',
+      :stories => '/stories',
       :userstories => '/stories/:username',
-      :userstory => '/stories/:username/:slug'
+      :userstory => '/stories/:username/:slug',
+      :latest => '/stories/browse/latest',
+      :featured => '/stories/browse/featured',
+      :popular => '/stories/browse/popular'
     }
   }
 
@@ -26,6 +30,14 @@ module Storify
 
     uri
   end
+
+  def self.error(code, message, type, end_of_content: {})
+    unless message.downcase.include?('max')
+      raise Storify::ApiError.new(code, message, type)
+    end
+
+    end_of_content
+  end
 end
 
 require 'storify/story'

data/spec/client_noauth_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+# These methods did not work with authentication,
+# so they have been forced to not use the auth token
+
+describe "Storify::Client -- Unauthenticated" do
+  before(:each) do
+    @client = Storify::Client.new(@api_key, @username)
+    @options = {:version => :v1, :protocol => :insecure}
+  end
+
+  context "GET /stories" do
+    it "should get all stories until the maximum" do
+      @client.stories.length.should > 400
+    end
+
+    it "should accept endpoint options (version, protocol)" do
+      @client.stories(options: @options).length.should > 400
+    end
+
+    it "should accept paging options (Pager)" do
+      pager = Storify::Pager.new(page: 1, max: 2, per_page: 20)
+      @client.stories(pager: pager).length.should == 40
+    end
+  end
+
+  context "GET /stories/browse/latest" do
+    it "should get all the latest stories until the maximum" do
+      @client.latest.length.should > 400
+    end
+
+    it "should accept endpoint options (version, protocol)" do
+      @client.latest(options: @options).length > 400
+    end
+
+    it "should get the top 20 stories" do
+      pager = Storify::Pager.new(page: 1, max: 1, per_page: 20)
+      @client.latest(pager: pager).length.should == 20
+    end
+  end
+
+  context "GET /stories/browse/featured" do
+    it "should get all the featured stories until the maximum" do
+      @client.featured.length.should > 400
+    end
+
+    it "should accept endpoint options (version, protocol)" do
+      @client.featured(options: @options).length > 400
+    end
+
+    it "should get the top 20 featured stories" do
+      pager = Storify::Pager.new(page: 1, max: 1, per_page: 20)
+      @client.featured(pager: pager).length.should == 20
+    end
+  end
+
+  context "GET /stories/browse/popular" do
+    it "should get all the popular stories until the maximum" do
+      @client.popular.length.should > 400
+    end
+
+    it "should accept endpoint options (version, protocol)" do
+      @client.popular(options: @options).length > 400
+    end
+
+    it "should get the top 15 popular stories" do
+      p = Storify::Pager.new(page: 1, max: 1, per_page: 15)
+      @client.popular(pager: p).length.should == 15
+    end
+  end
+end

data/spec/storify_spec.rb

@@ -38,6 +38,22 @@ describe Storify do
       Storify::ENDPOINTS[:v1][:auth].should == "/auth"
     end
 
+    it "should support the Stories endpoint" do
+      Storify::ENDPOINTS[:v1][:stories].should == "/stories"
+    end
+
+    it "should support the Latest Stories endpoint" do
+      Storify::ENDPOINTS[:v1][:latest].should == "/stories/browse/latest"
+    end
+
+    it "should support the Featured Stories endpoint" do
+      Storify::ENDPOINTS[:v1][:featured].should == "/stories/browse/featured"
+    end
+
+    it "should support the Popular Stories endpoint" do
+      Storify::ENDPOINTS[:v1][:popular].should == "/stories/browse/popular"
+    end
+
     it "should support the User Stories endpoint" do
       Storify::ENDPOINTS[:v1][:userstories].should == "/stories/:username"
     end
@@ -76,4 +92,17 @@ describe Storify do
       uri.should == 'http://api.storify.com/v1/stories/rtejpar'
     end
   end
+
+  context "API v1 Error Handling" do
+    it "should return an empty content block (if api max reached)" do
+      eoc = Storify::Client::EOC
+      content = Storify::error(400, '...Max...', 'bad request', end_of_content: eoc)
+      content.should == eoc
+    end
+
+    it "should return an API error for a non-max case" do
+      eoc = Storify::Client::EOC
+      expect{Storify::error(400, '...', 'bad request', end_of_content: eoc)}.to raise_error(Storify::ApiError)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storify
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Rizwan Tejpar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -93,6 +93,7 @@ files:
 - lib/storify/story.rb
 - lib/storify.rb
 - spec/client_auth_spec.rb
+- spec/client_noauth_spec.rb
 - spec/client_spec.rb
 - spec/pager_spec.rb
 - spec/spec_helper.rb
@@ -123,6 +124,7 @@ specification_version: 4
 summary: Storify API
 test_files:
 - spec/client_auth_spec.rb
+- spec/client_noauth_spec.rb
 - spec/client_spec.rb
 - spec/pager_spec.rb
 - spec/spec_helper.rb