npr 1.1.0 → 1.2.0

data/lib/npr/entity/story.rb

@@ -7,9 +7,9 @@ module NPR
       class << self
         #-------------------------
         # Find a story based on ID
-        # 
+        #
         # This method is meant to be a quick, easy
-        # way to find a story just by its ID. 
+        # way to find a story just by its ID.
         #
         # If you need more control over what gets
         # fetched and how, use NPR::Client directly,
@@ -17,8 +17,8 @@ module NPR
         # +order+, etc.)
         #
         # It is not possible to pass options into this
-        # method. Therefore, you *must* globally 
-        # configure at least the apiKey using 
+        # method. Therefore, you *must* globally
+        # configure at least the apiKey using
         # +NPR.configure+.
         #
         # Example:
@@ -27,20 +27,20 @@ module NPR
         #
         def find(id)
           response = query_by_id(id)
-        
+
           if !response.messages.empty?
             response.messages
           else
             response.list.stories.first
           end
         end
-        
+
         #-------------------------
         # Same as above, but returns +nil+ if a single story isn't
         # returned.
         def find_by_id(id)
           response = query_by_id(id)
-          
+
           if !response.messages.empty?
             nil
           else
@@ -54,18 +54,18 @@ module NPR
         # QueryBuilder and proxies to its corresponding method on
         # Query Builder class.
         #
-        # We could use ActiveSupport's delegation for this, but 
+        # We could use ActiveSupport's delegation for this, but
         # this is simple enough.
         NPR::API::QueryBuilder::CLASS_BUILDER_METHODS.each do |method|
           define_method method do |args|
             NPR::API::QueryBuilder.new(self).send(method, args)
           end
         end
-      
+
         #-------------------------
-        
+
         private
-      
+
         def query_by_id(id)
           client.query(:id => id)
         end
@@ -79,38 +79,30 @@ module NPR
       end
 
       #-------------------------
-      # Association accessors
-    
-      # Attributes that we are using as-is
-      # Use strings so that we don't have to
-      # convert between Strings and Symbols.
-      ATTR_AS_IS = [
-        "thumbnail", 
-        "parent", 
-        "container"
-      ]
-      attr_accessor *ATTR_AS_IS
-      attr_accessor :id, :text, :textWithHtml
-    
+
+      attr_accessor :id, :text, :textWithHtml, :thumbnail, :container
+
       #------------------
-    
-      has_many "images",        :key => "image",        :class_name => NPR::Entity::Image
-      has_many "bylines",       :key => "byline",       :class_name => NPR::Entity::Byline
-      has_many "audio",         :key => "audio",        :class_name => NPR::Entity::Audio
-      has_many "organizations", :key => "organization", :class_name => NPR::Entity::Organization
-      has_many "links",         :key => "link",         :class_name => NPR::Entity::Link
-      has_many "related_links", :key => "relatedLink",  :class_name => NPR::Entity::RelatedLink
-      has_many "pull_quotes",   :key => "pullQuote",    :class_name => NPR::Entity::PullQuote
-      has_many "shows",         :key => "show",         :class_name => NPR::Entity::Show
-      has_many "members",       :key => "member",       :class_name => NPR::Entity::Member
-      has_many "list_texts",    :key => "listText",     :class_name => NPR::Entity::ListText
-      has_many "promo_arts",    :key => "promoArt",     :class_name => NPR::Entity::PromoArt
-      has_many "book_editions", :key => "bookEdition",  :class_name => NPR::Entity::BookEdition
-      
+
+      include NPR::Concern::LinksAssociation
+      has_many "audio",           :key => "audio",         :class_name => NPR::Entity::Audio
+      has_many "book_editions",   :key => "bookEdition",   :class_name => NPR::Entity::BookEdition
+      has_many "bylines",         :key => "byline",        :class_name => NPR::Entity::Byline
+      has_many "external_assets", :key => "externalAsset", :class_name => NPR::Entity::ExternalAsset
+      has_many "images",          :key => "image",         :class_name => NPR::Entity::Image
+      has_many "list_texts",      :key => "listText",      :class_name => NPR::Entity::ListText
+      has_many "members",         :key => "member",        :class_name => NPR::Entity::Member
+      has_many "organizations",   :key => "organization",  :class_name => NPR::Entity::Organization
+      has_many "parents",         :key => "parent",        :class_name => NPR::Entity::Parent
+      has_many "promo_arts",      :key => "promoArt",      :class_name => NPR::Entity::PromoArt
+      has_many "pull_quotes",     :key => "pullQuote",     :class_name => NPR::Entity::PullQuote
+      has_many "related_links",   :key => "relatedLink",   :class_name => NPR::Entity::RelatedLink
+      has_many "shows",           :key => "show",          :class_name => NPR::Entity::Show
+
       has_one "transcript", :class_name => NPR::Entity::Transcript
 
       #------------------
-    
+
       shallow_attribute(
         "title",
         "partnerId",
@@ -126,22 +118,22 @@ module NPR
         "priorityKeywords",
         "fullText"
       )
-        
+
       #-------------------------
 
       def initialize(json)
         @_json = json
         @id    = @_json["id"].to_i
-        
+
         build_text
         extract_shallow_attributes(@_json)
         create_relations(@_json)
       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.
       #
@@ -151,35 +143,18 @@ module NPR
           primary || self.images.first
         end
       end
-      
-      #-------------------------
-      # Find links of the passed in type.
-      #
-      # Example:
-      #
-      #   story.link_for("html")    #=> http://npr.org/...
-      #   story.link_for("nothing") #=> nil
-      #
-      # Returns an the content of that link if found, 
-      # or nil if not found.
-      #
-      def link_for(type)
-        if link = self.links.find { |link| link.type == type }
-          link.to_s
-        end
-      end
 
       #-------------------------
-      
+
       private
-      
+
       #-------------------------
-      
+
       def build_text
         if @_json["text"]
           @text = NPR::Entity::Text.new(@_json["text"])
         end
-        
+
         if @_json["textWithHtml"]
           @textWithHtml = NPR::Entity::Text.new(@_json["textWithHtml"])
         end
@@ -188,13 +163,8 @@ module NPR
   end # Entity
 
   #-------------------------
-  # Alias
-  # This is a shorthand so that users of this library
+  # A shorthand so that users of this library
   # can work with just NPR::Story, but allowing us to
   # keep everything organized properly.
-  #
-  # The other classes under Entity aren't part of the 
-  # library's public API, so they don't need to be
-  # aliased.
   Story = NPR::Entity::Story
 end # NPR

data/lib/npr/entity/text.rb

@@ -7,22 +7,22 @@ module NPR
       has_many "paragraphs", :key => "paragraph", :class_name => NPR::Entity::Paragraph
 
       #-----------------
-      
+
       def initialize(json)
         create_relations(json)
       end
-      
+
       #-----------------
-      
+
       def to_s
         @paragraphs.map(&:to_s).join("\n")
       end
-      
+
       #-----------------
-      # Turn this text node into an embeddable 
+      # Turn this text node into an embeddable
       # block of HTML.
       #
-      # This is useful if the fullText attribute 
+      # 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.
@@ -33,7 +33,7 @@ module NPR
         @paragraphs.each do |paragraph|
           result << "<p>" + paragraph.to_s + "</p>\n"
         end
-        
+
         result
       end
     end # Text

data/lib/npr/entity/title.rb

@@ -5,14 +5,14 @@ module NPR
   module Entity
     class Title < Base
       attr_accessor :num, :content
-      
+
       def initialize(json)
         @num     = json["num"].to_i
-        @content = json["$text"] 
+        @content = json["$text"]
       end
-      
+
       #--------------------
-      
+
       def to_s
         @content.to_s
       end

data/lib/npr/entity/transcript.rb

@@ -5,9 +5,9 @@ module NPR
   module Entity
     class Transcript < Base
       has_one "link", :class_name => NPR::Entity::Link
-      
+
       #-------------------
-      
+
       def initialize(json)
         create_relations(json)
       end

data/lib/npr/errors.rb

@@ -13,5 +13,5 @@ module NPR
   end
 
   class NotConfiguredError < ClientError
-  end  
+  end
 end # NPR

data/lib/npr/version.rb

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

data/lib/npr.rb

@@ -19,6 +19,7 @@ require "npr/concern"
 require "npr/concern/attr_typecast"
 require "npr/concern/shallow_attributes"
 require "npr/concern/relation"
+require "npr/concern/links_association"
 
 #------------------
 # API handlers
@@ -46,11 +47,13 @@ require "npr/entity/intro_text"
 require "npr/entity/member_byline"
 require "npr/entity/promo_art_book_edition"
 require "npr/entity/member"
+require "npr/entity/parent"
 require "npr/entity/collection"
 require "npr/entity/provider"
 require "npr/entity/enlargement"
 require "npr/entity/crop"
 require "npr/entity/image"
+require "npr/entity/external_asset"
 require "npr/entity/promo_art"
 require "npr/entity/mp3"
 require "npr/entity/formats"

data/spec/fixtures/fetch_formats.rb

@@ -21,7 +21,7 @@ options = {}
 
 OptionParser.new do |opts|
   opts.banner = "Usage: ruby fetch_formats.rb [ARGS]"
-  
+
   opts.on('-k', '--key KEY', 'Your NPR API Key') do |key|
     options[:key] = key
   end
@@ -51,15 +51,15 @@ ext_map = {
 # The fun stuff
 ext_map.keys.each do |output|
   puts "Fetching #{output}..."
-  
+
   uri = URI.parse("http://api.npr.org/query?apiKey=#{options[:key]}&id=#{options[:id]}&output=#{output}")
   response = Net::HTTP.get_response(uri).body
-  
+
   # Remove API Key from responses
   if !options[:key].empty? && !options[:key].nil?
     response.gsub!(/#{options[:key]}/, "API_KEY")
   end
-  
+
   file = "#{output}/#{options[:filename]}.#{ext_map[output]}"
   File.open(file, "w") { |f| f.puts response }
 end

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ RSpec.configure do |config|
   config.include FakeResponse
   config.include ConfigHelper
   config.include FixtureHelper
-  
+
   config.before do
     FakeWeb.clean_registry
   end

data/spec/unit/api/client_spec.rb

@@ -7,7 +7,7 @@ describe NPR::API::Client do
       client.instance_variable_get(:@apiKey).should eq "key"
       client.params.keys.should_not include :apiKey
     end
-    
+
     it "sets @url on initialize" do
       client = NPR::API::Client.new(:url => "http://api.publish2.com")
       client.url.should eq "http://api.publish2.com"
@@ -24,16 +24,16 @@ describe NPR::API::Client do
       client = NPR::API::Client.new
       client.params[:sort].should eq "super sort"
     end
-    
+
     it "passed-in params take precedence over global config" do
       NPR.config.sort = "global sort"
       client = NPR::API::Client.new(:sort => "local sort")
       client.params[:sort].should eq "local sort"
     end
   end
-  
+
   #-----------------
-  
+
   describe "#query" do
     it 'uses the passed-in path if available' do
       respond_with("json/01_story_full_media.json", :uri => %r|api\.publish2\.com/list/stories|)

data/spec/unit/api/message_spec.rb

@@ -16,31 +16,31 @@ describe NPR::API::Message do
         }
       JSON
     end
-  
+
     before :each do
       @message = NPR::API::Message.new(@fixture)
     end
-  
+
     it "sets level and id" do
       @message.id.should eq "203"
       @message.level.should eq "warning"
     end
-  
+
     it "returns true for #warning?" do
       @message.warning?.should eq true
     end
-    
+
     it "sets text" do
       @message.text.should match /^Query/
     end
-    
+
     it "sets timestamp" do
       @message.timestamp.should be_a Time
     end
   end
-  
+
   #---------------------------
-  
+
   describe "error" do
     json_fixture do
       <<-JSON
@@ -56,11 +56,11 @@ describe NPR::API::Message do
         }
       JSON
     end
-    
+
     before :each do
       @message = NPR::API::Message.new(@fixture)
     end
-    
+
     it "is an error" do
       @message.error?.should eq true
     end

data/spec/unit/api/query_builder_spec.rb

@@ -5,7 +5,7 @@ describe NPR::API::QueryBuilder do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "turns the query builder in params that the API can understand" do
       @builder.where(:id => 5).order("date descending").limit(10).offset(100)
       @builder.to_params.should eq Hash[
@@ -15,99 +15,99 @@ describe NPR::API::QueryBuilder do
         :startNum   => 100
       ]
     end
-    
+
     it "merges in @builder[:extra] last, which overrides anything" do
       @builder.set(:id => 5).where(:id => 10)
       @builder.to_params.should eq Hash[:id => 5]
     end
-    
+
     it "doesn't create params if the value was not set" do
       @builder.where(:id => 5).to_params.keys.should eq [:id]
     end
-    
+
     it "is an empty hash if no params are set" do
       @builder.to_params.should eq Hash.new
     end
   end
 
   #----------------------
-  
+
   describe "#to_a" do
     config!(:apiKey => "key")
-    
+
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
       @builder.set(:apiKey => "key")
     end
-    
+
     it "returns an array of stories if present" do
       @builder.where(:id => 5).order("date descending").limit(10).offset(100)
-      
+
       stories = mock_response "json/06_story_multiple_ids.json" do
         @builder.to_a
       end
-      
+
       stories.should be_a Array
       stories.should_not be_empty
       stories.first.should be_a NPR::Story
     end
-    
+
     it "returns an empty array if no list or no stories were found" do
       @builder.where(:id => 5).order("date descending").limit(10).offset(100)
-      
+
       stories = mock_response "json/05_no_api_key.json" do
         @builder.to_a
       end
-      
+
       stories.should be_a Array
       stories.should be_empty
     end
   end
 
   #----------------------
-  
+
   describe "#query" do
     config!(:apiKey => "key")
-    
+
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "sends off a query and returns the response object" do
       response = mock_response "json/01_story_full_media.json" do
         @builder.where(:id => 100).query
       end
-      
+
       response.should be_a NPR::API::Response
-    end      
+    end
   end
-  
+
   #----------------------
-  
+
   describe "#set" do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "sets arbitrary parameters" do
       @builder.set(:whatever => "something cool")
       @builder.builder[:extra].should eq Hash[
         :whatever => "something cool"
       ]
     end
-    
+
     it "returns itself" do
       @builder.set(:a => "b").should eq @builder
     end
   end
-  
+
   #----------------------
 
   describe "#where" do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "adds the conditions to the query builder" do
       @builder.where(:id => 9999)
       @builder.where(:origId => 100)
@@ -118,70 +118,70 @@ describe NPR::API::QueryBuilder do
           :origId => 100
         }]
     end
-    
+
     it "returns itself" do
       @builder.where(:id => 0).should eq @builder
     end
   end
-  
+
   #----------------------
-  
+
   describe "#order" do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "adds the order to the query builder" do
       @builder.order("date descending")
       @builder.builder.should eq Hash[:order => "date descending"]
     end
-    
+
     it "returns itself" do
       @builder.order("date ascending").should eq @builder
     end
   end
-  
+
   #----------------------
-  
+
   describe "#limit" do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "adds the limit to the query builder" do
       @builder.limit(10)
       @builder.builder.should eq Hash[:limit => 10]
     end
-    
+
     it "returns itself" do
       @builder.limit(0).should eq @builder
     end
   end
-  
+
   #----------------------
-  
+
   describe "#offset" do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "adds the offset to the query builder" do
       @builder.offset(100)
       @builder.builder.should eq Hash[:offset => 100]
     end
-    
+
     it "returns itself" do
       @builder.offset(0).should eq @builder
     end
   end
-  
+
   #----------------------
-  
+
   describe "chaining queries" do
     before :each do
       @builder = NPR::API::QueryBuilder.new(NPR::Story)
     end
-    
+
     it "can chain the queries" do
       @builder.where(:id => 5).order("date descending").limit(10).offset(100)
       @builder.builder.should eq Hash[