npr 0.1.2 → 1.1.0

data/.travis.yml

@@ -4,10 +4,5 @@ rvm:
   - 1.9.2
   - ruby-head
 
-matrix:
-  include:
-    - rvm: 1.8.7
-      gemfile: gemfiles/Gemfile.rb-1.8.7
-
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,7 +1,20 @@
-### Version 0.2.0 (unreleased)
-* Deeper byline implementation
-* Add `primary?` and `standard?` methods to Image to check type
-* Add `Story#link_for` for finding link of a certain type
+### Version 1.1.0 (2013-06-05)
+* Allow passing `:url` option to Client, and `:path` option to `Client#query`
+* Allow passing `:apiKey` and `:output` to `Client#query`
+* Handle an HTTP Error from the API better. If the API response is not a
+  success (as defined by `Faraday::Response#success?`), then an 
+  `NPR::APIError` will be raised. An error was being raised before, but
+  it was due to a nil error (when response.body was nil), which could be confusing.
+* Add an Image#crop method, to find a specific crop by its type.
+
+
+### Version 1.0.0
+* Stable release
+
+
+### Version 0.1.2 (2012-12-30)
+* Critical bug fix having to do with JSON parsing.
+
 
 ### Version 0.1.1 (2012-12-16)
 * First stable release.

data/README.md

@@ -2,8 +2,6 @@
 
 [![Build Status](https://travis-ci.org/bricker/npr.png)](https://travis-ci.org/bricker/npr)
  
-**NOTE** This gem is a WIP
-
 A simple Ruby client for the 
 [NPR API](http://www.npr.org/api/index).
 
@@ -13,7 +11,7 @@ A simple Ruby client for the
 This gem is tested with these versions (but may 
 work with others):
 
-* Ruby 1.8.7, 1.9.2, 1.9.3, ruby-head
+* Ruby 1.9.2, 1.9.3, ruby-head
 * NPR API version 0.94
 
 
@@ -22,19 +20,6 @@ work with others):
 * `faraday >= 0.8.0` (HTTP requests)
 * `faraday_middleware >= 0.9.0` (response processing)
 
-**NOTE** If you are running **Ruby < 1.9**, you will have to install 
-the [json gem](http://rubygems.org/gems/json):
-
-In your Gemfile:
-
-    gem 'json', '~> 1.7.5'
-    
-From the command line:
-
-    $ gem install json
-
-Ruby 1.9+ comes with JSON support built-in!
-
 
 ## Installation
 

data/lib/npr/api/client.rb

@@ -16,7 +16,7 @@
 module NPR
   module API
     class Client
-      attr_accessor :params
+      attr_accessor :params, :url
 
       #-----------------
       # Argument is a hash of params to send to the API.
@@ -32,6 +32,7 @@ module NPR
       #
       def initialize(params={})
         @params = NPR.config.merge(params)
+        @url    = @params.delete(:url) || NPR::Configuration::API_ROOT
         @apiKey = @params.delete(:apiKey)
       end
 
@@ -54,19 +55,22 @@ module NPR
       # TODO: Support more formats
       #
       def query(params={})
-        if @apiKey.nil?
-          raise NPR::NotConfiguredError, "apiKey must be set to perform a query"
-        end
+        path = params.delete(:path) || NPR::Configuration::API_QUERY_PATH
       
         response = connection.get do |request|
-          request.url NPR::Configuration::API_QUERY_PATH
-          request.params = @params.merge(params)
+          request.url path
           request.headers['Content-Type'] = "application/json"
-          request.params['output'] = "json"
-          request.params['apiKey'] = @apiKey
+
+          request.params = @params.merge(params)
+          request.params['output'] ||= "json"  # Only JSON is supported.
+          request.params['apiKey'] ||= @apiKey
         end
         
-        NPR::API::Response.new(response)
+        if response.success?
+          NPR::API::Response.new(response)
+        else
+          raise NPR::APIError, "The API call failed. (Status: #{response.status})"
+        end
       end
 
       #-----------------
@@ -77,7 +81,7 @@ module NPR
     
       def connection
         @connection ||= begin
-          Faraday.new NPR::Configuration::API_ROOT do |conn|
+          Faraday.new @url do |conn|
             conn.response :json
             conn.adapter Faraday.default_adapter
           end

data/lib/npr/api/query_builder.rb

@@ -44,10 +44,6 @@ module NPR
       #-----------------------
       # Fire the query and return an Array of stories (or empty [])
       #
-      # Named +to_a+ to keep in line with ActiveRecord::Relation's
-      # naming convention. It is also aliased as +query+, which 
-      # probably makes a little more sense.
-      #
       # Returns an Array. If the query returned any stories, then
       # it will be an array of those stories. If no stories were
       # returned, then it will be an empty array.
@@ -73,7 +69,7 @@ module NPR
         response = self.query
         stories  = []
       
-        if list = response.list
+        if response.list
           stories = Array.wrap(response.list.stories)
         end
       

data/lib/npr/api/response.rb

@@ -19,7 +19,7 @@ module NPR
         
         @_response = response
         @raw       = response.body
-                
+        
         @version  = @raw["version"]
                 
         if list = @raw["list"]

data/lib/npr/entity/crop.rb

@@ -17,4 +17,3 @@ module NPR
     end # Crop
   end # Entity
 end # NPR
-

data/lib/npr/entity/enlargement.rb

@@ -16,5 +16,3 @@ module NPR
     end # Enlargement
   end # Entity
 end # NPR
-
-      

data/lib/npr/entity/formats.rb

@@ -16,4 +16,4 @@ module NPR
       end
     end # Formats
   end # Entity
-end # NPR
+end # NPR

data/lib/npr/entity/image.rb

@@ -9,8 +9,8 @@ module NPR
       has_many "crops", :key => "crop", :class_name => NPR::Entity::Crop
       has_one "enlargement", :class_name => NPR::Entity::Enlargement
       has_one "provider", :class_name => NPR::Entity::Provider
-      
-      #-------------
+
+
       # NOTE that the "link" attribute here is not cast into a Link
       # object, and the "url" parameter is ignored. Instead, just 
       # calling +image.link+ will return the URL parameter.
@@ -28,15 +28,37 @@ module NPR
         extract_shallow_attributes(json)
         create_relations(json)
       end
-      
-      #--------------------
-      
+
+
+      # Find a crop by its type.
+      # 
+      # Arguments:
+      #
+      # * (String) type - the type of crop you're looking for
+      #
+      #
+      # Examples:
+      #
+      #   image.crop("enlargement") #=> NPR::Entity::Crop
+      #   image.crop("missing")     #=> nil
+      #
+      # Returns: An NPR::Entity::Crop, or nil if none found.
+      def crop(type)
+        self.crops.find { |c| c.type == type }
+      end
+
+
+      # Determine if this image is the primary image (as defined by NPR).
+      #
+      # Returns: Boolean
       def primary?
         @type == "primary"
       end
-      
-      #--------------------
-      
+
+
+      # Determine if this image is the standard image (as defined by NPR).
+      #
+      # Returns: Boolean
       def standard?
         @type == "standard"
       end

data/lib/npr/entity/intro_text.rb

@@ -14,7 +14,7 @@ module NPR
       #--------------------
       
       def to_s
-        @content
+        @content.to_s
       end
     end # IntroText
   end # Entity

data/lib/npr/entity/link.rb

@@ -16,7 +16,7 @@ module NPR
       #---------------------
     
       def to_s
-        @content
+        @content.to_s
       end
     end # Link
   end # Entity

data/lib/npr/entity/mp3.rb

@@ -16,7 +16,7 @@ module NPR
       #-----------------
       
       def to_s
-        @content
+        @content.to_s
       end
     end # MP3
   end # Entity

data/lib/npr/entity/name.rb

@@ -18,7 +18,7 @@ module NPR
       #-------------------
       
       def to_s
-        @content
+        @content.to_s
       end
     end # Name
   end # Entity

data/lib/npr/entity/paragraph.rb

@@ -20,7 +20,7 @@ module NPR
       #---------------------
     
       def to_s
-        @content
+        @content.to_s
       end
     end # Paragraph
   end # Entity

data/lib/npr/entity/program.rb

@@ -17,7 +17,7 @@ module NPR
       #---------------------
     
       def to_s
-        @content
+        @content.to_s
       end
     end # Program
   end # Entity

data/lib/npr/entity/provider.rb

@@ -16,7 +16,7 @@ module NPR
       #----------------
       
       def to_s
-        @content
+        @content.to_s
       end
     end # Provider
   end # Entity

data/lib/npr/entity/story.rb

@@ -4,8 +4,6 @@
 module NPR
   module Entity
     class Story < Base
-      #-------------------------
-    
       class << self
         #-------------------------
         # Find a story based on ID
@@ -69,12 +67,15 @@ module NPR
         private
       
         def query_by_id(id)
-          client = NPR::API::Client.new(
-            :apiKey => NPR.config.apiKey,
-            :output => "json")
-
           client.query(:id => id)
         end
+
+        def client
+          @client ||= NPR::API::Client.new(
+            :apiKey => NPR.config.apiKey,
+            :output => "json"
+          )
+        end
       end
 
       #-------------------------
@@ -138,9 +139,12 @@ module NPR
       end
     
       #-------------------------
-      # The primary image. Looks at the "type" attribute on 
+      # The primary image. 
+      # 
+      # Looks at the "type" attribute on 
       # an image and finds any with type "primary". If none
       # are found, then return the first image of any type.
+      #
       def primary_image
         @primary_image ||= begin
           primary = self.images.find(&:primary?)
@@ -153,13 +157,16 @@ module NPR
       #
       # Example:
       #
-      #   story.link_for("html")    #=> NPR::Entity::Link
+      #   story.link_for("html")    #=> http://npr.org/...
       #   story.link_for("nothing") #=> nil
       #
-      # Returns an NPR::Entity::Link or nil
+      # Returns an the content of that link if found, 
+      # or nil if not found.
       #
       def link_for(type)
-        self.links.find { |link| link.type == type }
+        if link = self.links.find { |link| link.type == type }
+          link.to_s
+        end
       end
 
       #-------------------------

data/lib/npr/entity/text.rb

@@ -17,6 +17,25 @@ module NPR
       def to_s
         @paragraphs.map(&:to_s).join("\n")
       end
+      
+      #-----------------
+      # Turn this text node into an embeddable 
+      # block of HTML.
+      #
+      # This is useful if the fullText attribute 
+      # is missing on an NPR Story. It will not
+      # be as robust as a full HTML body from
+      # NPR, but it will work in most cases.
+      #
+      def to_html
+        result = ""
+
+        @paragraphs.each do |paragraph|
+          result << "<p>" + paragraph.to_s + "</p>\n"
+        end
+        
+        result
+      end
     end # Text
   end # Entity
 end # NPR

data/lib/npr/entity/title.rb

@@ -14,7 +14,7 @@ module NPR
       #--------------------
       
       def to_s
-        @content
+        @content.to_s
       end
     end # Title
   end # Entity

data/lib/npr/errors.rb

@@ -4,14 +4,14 @@
 module NPR
   class ClientError < StandardError
   end
-  
-  #-------------------
-  
+
   class ServerError < StandardError
   end
-  
-  #-------------------
-  
+
+
+  class APIError < ServerError
+  end
+
   class NotConfiguredError < ClientError
   end  
 end # NPR

data/lib/npr/version.rb

@@ -1,3 +1,3 @@
 module NPR
-  VERSION = "0.1.2"
+  VERSION = "1.1.0"
 end

data/npr.gemspec

@@ -1,27 +1,27 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/npr/version', __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Bryan Ricker"]
-  gem.email         = ["bricker@scpr.org"]
-  gem.description   = %q{NPR (npr.org) is a news organization. This gem helps you pull NPR content with a nice Ruby DSL.}
-  gem.summary       = %q{A Ruby client for the NPR API}
-  gem.homepage      = "http://github.com/bricker/npr"
+Gem::Specification.new do |s|
+  s.name          = "npr"
+  s.version       = NPR::VERSION
+  s.authors       = ["Bryan Ricker"]
+  s.email         = ["bricker@scpr.org"]
+  s.description   = %q{NPR (npr.org) is a news organization. This gem helps you pull NPR content with a nice Ruby DSL.}
+  s.summary       = %q{A Ruby client for the NPR API}
+  s.homepage      = "http://github.com/bricker/npr"
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "npr"
-  gem.require_paths = ["lib"]
-  gem.version       = NPR::VERSION
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
   
-  gem.licenses = ['MIT']
+  s.licenses = ['MIT']
   
-  gem.add_dependency 'faraday', ['>= 0.8.0']
-  gem.add_dependency 'faraday_middleware', ['>= 0.9.0']
+  s.add_dependency 'faraday', '>= 0.8.0'
+  s.add_dependency 'faraday_middleware', '>= 0.9.0'
 
-  gem.add_development_dependency 'bundler', ['>= 1.0.0']
-  gem.add_development_dependency 'rake', ['>= 0']
-  gem.add_development_dependency 'rspec', ['>= 0']
-  gem.add_development_dependency 'fakeweb', ['>= 0']
+  s.add_development_dependency 'bundler', '>= 1.0.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fakeweb'
 end