npr 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 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 0.1.1 (2012-12-16)
+* First stable release.

data/lib/npr/api/client.rb

@@ -61,6 +61,7 @@ module NPR
         response = connection.get do |request|
           request.url NPR::Configuration::API_QUERY_PATH
           request.params = @params.merge(params)
+          request.headers['Content-Type'] = "application/json"
           request.params['output'] = "json"
           request.params['apiKey'] = @apiKey
         end
@@ -77,7 +78,7 @@ module NPR
       def connection
         @connection ||= begin
           Faraday.new NPR::Configuration::API_ROOT do |conn|
-            conn.response :json, :content_type => /\bjson$/
+            conn.response :json
             conn.adapter Faraday.default_adapter
           end
         end

data/lib/npr/api/response.rb

@@ -16,14 +16,17 @@ module NPR
       
       def initialize(response)
         create_relations(response)
-        @raw      = response
-        @version  = response.body["version"]
         
-        if response.body["list"]
-          @list = NPR::Entity::List.new(response.body["list"])
+        @_response = response
+        @raw       = response.body
+                
+        @version  = @raw["version"]
+                
+        if list = @raw["list"]
+          @list = NPR::Entity::List.new(list)
         end
         
-        Array.wrap(response.body["message"]).each do |message|
+        Array.wrap(@raw["message"]).each do |message|
           @messages.push NPR::API::Message.new(message)
         end
       end

data/lib/npr/entity/byline.rb

@@ -5,13 +5,14 @@ module NPR
   module Entity
     class Byline < Base
       attr_accessor :id
-      shallow_attribute "name"
+      has_many "links", :key => "link", :class_name => NPR::Entity::Link
+      has_one "name", :class_name => NPR::Entity::Name
       
       #-----------------
       
       def initialize(json)
         @id = json["id"].to_i
-        extract_shallow_attributes(json)
+        create_relations(json)
       end
     end # Byline
   end # Entity

data/lib/npr/entity/image.rb

@@ -28,6 +28,18 @@ module NPR
         extract_shallow_attributes(json)
         create_relations(json)
       end
+      
+      #--------------------
+      
+      def primary?
+        @type == "primary"
+      end
+      
+      #--------------------
+      
+      def standard?
+        @type == "standard"
+      end
     end # Image
   end # Entity
 end # NPR

data/lib/npr/entity/name.rb

@@ -0,0 +1,25 @@
+##
+# NPR::Entity::Namew
+#
+# Byline name
+#
+module NPR
+  module Entity
+    class Name < Base
+      attr_accessor :personId, :content
+      
+      #-------------------
+      
+      def initialize(json)
+        @personId = json["personId"].to_i
+        @content  = json["$text"]
+      end
+      
+      #-------------------
+      
+      def to_s
+        @content
+      end
+    end # Name
+  end # Entity
+end # NPR

data/lib/npr/entity/story.rb

@@ -143,10 +143,24 @@ module NPR
       # are found, then return the first image of any type.
       def primary_image
         @primary_image ||= begin
-          primary = self.images.find { |i| i["type"] == "primary"}
+          primary = self.images.find(&:primary?)
           primary || self.images.first
         end
       end
+      
+      #-------------------------
+      # Find links of the passed in type.
+      #
+      # Example:
+      #
+      #   story.link_for("html")    #=> NPR::Entity::Link
+      #   story.link_for("nothing") #=> nil
+      #
+      # Returns an NPR::Entity::Link or nil
+      #
+      def link_for(type)
+        self.links.find { |link| link.type == type }
+      end
 
       #-------------------------
       

data/lib/npr/version.rb

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

data/lib/npr.rb

@@ -58,6 +58,7 @@ require "npr/entity/permissions"
 require "npr/entity/audio"
 require "npr/entity/book"
 require "npr/entity/book_edition"
+require "npr/entity/name"
 require "npr/entity/byline"
 require "npr/entity/program"
 require "npr/entity/show"

data/spec/unit/entity/byline_spec.rb

@@ -4,10 +4,21 @@ describe NPR::Entity::Byline do
   json_fixture do
     <<-JSON
       {
-        "id": "166481173",
+        "id": "166885535",
         "name": {
-          "$text": "Annalee Newitz"
-        }
+          "personId": "134991966",
+          "$text": "Julie Bierach"
+        },
+        "link": [
+          {
+            "type": "html",
+            "$text": "http://news.stlpublicradio.org/people/julie-bierach"
+          },
+          {
+            "type": "api",
+            "$text": "http://api.npr.org/query?id=134991966&apiKey=MDA1OTI3MjQ5MDEyODUwMTE2MzM1YzNmZA004"
+          }
+        ]
       }
     JSON
   end
@@ -17,7 +28,13 @@ describe NPR::Entity::Byline do
   end
   
   it "sets up attributes" do
-    @byline.id.should eq 166481173
-    @byline.name.should match /Annalee/
+    @byline.id.should be_a Fixnum
+    @byline.id.should_not eq 0
+  end
+  
+  it "creates relations" do
+    @byline.links.size.should eq 2
+    @byline.links.first.should be_a NPR::Entity::Link
+    @byline.name.should be_a NPR::Entity::Name
   end
 end

data/spec/unit/entity/image_spec.rb

@@ -79,4 +79,9 @@ describe NPR::Entity::Image do
     @image.producer.should eq ""
     @image.copyright.should eq ""
   end
+  
+  it "responds to type methods" do
+    @image.primary?.should eq false
+    @image.standard?.should eq true
+  end
 end

data/spec/unit/entity/name_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe NPR::Entity::Name do
+  json_fixture do
+    <<-JSON
+      {
+        "personId": "134991966",
+        "$text": "Julie Bierach"
+      }
+    JSON
+  end
+  
+  before :each do
+    @name = NPR::Entity::Name.new(@fixture)
+  end
+  
+  it "sets attributes" do
+    @name.personId.should eq 134991966
+    @name.content.should match /Julie/
+  end
+  
+  it "uses @content for to_s" do
+    @name.to_s.should eq @name.content
+  end
+end

data/spec/unit/entity/story_spec.rb

@@ -150,5 +150,46 @@ describe NPR::Entity::Story do
       query = NPR::Entity::Story.offset(args)
       query.builder[:offset].should eq args
     end
-  end  
+  end
+  
+  #--------------------
+  
+  describe "#primary_image" do
+    before :each do
+      @story = mock_response "json/02_story_multiple_images.json" do
+        NPR::Story.find(999)
+      end
+    end
+    
+    it "finds the first image with type 'primary'" do
+      @story.primary_image.type.should eq "primary"
+    end
+    
+    it "falls back to just the first image if no primary image is available" do
+      # Remove the type "primary" image from the json response
+      @story.images.delete_if { |i| i.type == "primary" }
+      @story.primary_image.type.should eq "standard"
+    end
+  end
+  
+  #--------------------
+  
+  describe "#link_for" do
+    before :each do
+      @story = mock_response "json/02_story_multiple_images.json" do
+        NPR::Story.find(999)
+      end
+    end
+    
+    it "finds the link for the passed-in type if it exists" do
+      @story.link_for("html").should be_a NPR::Entity::Link
+    end
+    
+    it "is nil if the type isn't present" do
+      @story.link_for("nothing").should eq nil
+    end
+  end
+  
+  #--------------------
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: npr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -154,6 +155,7 @@ files:
 - lib/npr/entity/member_byline.rb
 - lib/npr/entity/member_promo_art.rb
 - lib/npr/entity/mp3.rb
+- lib/npr/entity/name.rb
 - lib/npr/entity/organization.rb
 - lib/npr/entity/paragraph.rb
 - lib/npr/entity/permissions.rb
@@ -252,6 +254,7 @@ files:
 - spec/unit/entity/member_promo_art_spec.rb
 - spec/unit/entity/member_spec.rb
 - spec/unit/entity/mp3_spec.rb
+- spec/unit/entity/name_spec.rb
 - spec/unit/entity/organization_spec.rb
 - spec/unit/entity/paragraph_spec.rb
 - spec/unit/entity/permissions_spec.rb
@@ -372,6 +375,7 @@ test_files:
 - spec/unit/entity/member_promo_art_spec.rb
 - spec/unit/entity/member_spec.rb
 - spec/unit/entity/mp3_spec.rb
+- spec/unit/entity/name_spec.rb
 - spec/unit/entity/organization_spec.rb
 - spec/unit/entity/paragraph_spec.rb
 - spec/unit/entity/permissions_spec.rb