npr 1.2.0 → 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+### Version 2.0.0 (2013-11-08)
+##### Additions
+* Added `NPR::Entity::Stream`.
+* Added `empty?` method to `NPR::Entity::Formats`. Since `audio.formats` isn't
+  actually an Enumerable, this method is defined to make it easy to check if
+  any formats have been provided for this audio. This is a good way to check
+  if the audio is actually available yet.
+
+##### Changes
+* `Audio#stream` now returns an `NPR::Entity::Stream` object. This will break
+  your code if you were doing something like `if audio.stream == true`.
+  To fix it, you can just use: `if audio.stream.active?`. 
+* Changed the `offset` method on `QueryBuilder` to set `startNum` to
+  `offset + 1`. Previously, if you said `.offset(1)`, you would actually still
+  get the first result, because it was passing its value directly to the
+  `startNum` parameter, which is confusing. Now you can say `.offset(1)` and
+  the results will actually be offset by 1 object. This behavior is to mimic
+  ActiveRecord a little more closely.
+
+##### Deprecations
+* None
+
+
 ### Version 1.2.0 (2013-08-05)
 ##### Additions
 * Added support for the `parent` node.

data/README.md

@@ -115,8 +115,6 @@ for all of the options.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Please send PR's for any new features or bug fixes!
+
+Run tests with `bundle exec rake test`.

data/lib/npr/api/query_builder.rb

@@ -33,10 +33,10 @@ module NPR
         end
 
         params = conditions || {}
-        params[:sort]       = @builder[:order]  if @builder[:order]
-        params[:numResults] = @builder[:limit]  if @builder[:limit]
-        params[:startNum]   = @builder[:offset] if @builder[:offset]
-        params.merge!(@builder[:extra])         if @builder[:extra]
+        params[:sort]       = @builder[:order]      if @builder[:order]
+        params[:numResults] = @builder[:limit]      if @builder[:limit]
+        params[:startNum]   = @builder[:offset] + 1 if @builder[:offset]
+        params.merge!(@builder[:extra])             if @builder[:extra]
 
         params
       end

data/lib/npr/entity/audio.rb

@@ -4,21 +4,18 @@
 module NPR
   module Entity
     class Audio < Base
-      attr_accessor :id, :type, :stream
+      attr_accessor :id, :type
       shallow_attribute "title", "duration", "description", "rightsHolder"
       has_one "permissions", :class_name => NPR::Entity::Permissions
       has_one "formats", :key => "format", :class_name => NPR::Entity::Formats
+      has_one "stream", :class_name => NPR::Entity::Stream
 
       #-------------------
-      # +stream+ returns true if "active" is set to "true"
+
       def initialize(json)
         @id   = json["id"].to_i
         @type = json["type"]
 
-        if json["stream"]
-          @stream = json["stream"]["active"] == "true"
-        end
-
         create_relations(json)
         extract_shallow_attributes(json)
       end

data/lib/npr/entity/formats.rb

@@ -14,6 +14,13 @@ module NPR
         extract_shallow_attributes(json)
         create_relations(json)
       end
+
+      def empty?
+        mp3s.empty? &&
+        !wm &&
+        !rm &&
+        !mediastream
+      end
     end # Formats
   end # Entity
 end # NPR

data/lib/npr/entity/story.rb

@@ -103,7 +103,7 @@ module NPR
 
       #------------------
 
-      shallow_attribute(
+      shallow_attribute \
         "title",
         "partnerId",
         "subtitle",
@@ -117,7 +117,6 @@ module NPR
         "keywords",
         "priorityKeywords",
         "fullText"
-      )
 
       #-------------------------
 

data/lib/npr/entity/stream.rb

@@ -0,0 +1,16 @@
+##
+# NPR::Entity::Stream
+module NPR
+  module Entity
+    class Stream < Base
+      attr_accessor :active
+      alias_method :active?, :active
+
+      #-------------------
+
+      def initialize(json)
+        @active = json["active"] == "true"
+      end
+    end # Name
+  end # Entity
+end # NPR

data/lib/npr/version.rb

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

data/lib/npr.rb

@@ -58,6 +58,7 @@ require "npr/entity/promo_art"
 require "npr/entity/mp3"
 require "npr/entity/formats"
 require "npr/entity/permissions"
+require "npr/entity/stream"
 require "npr/entity/audio"
 require "npr/entity/book"
 require "npr/entity/book_edition"

data/npr.gemspec

@@ -6,17 +6,21 @@ Gem::Specification.new do |s|
   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.description   = "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"
 
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  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"]
-  
+
   s.licenses = ['MIT']
-  
+
   s.add_dependency 'faraday', '>= 0.8.0'
   s.add_dependency 'faraday_middleware', '>= 0.9.0'
 

data/spec/support/config_helper.rb

@@ -7,33 +7,33 @@ module ConfigHelper
   end
 
   #------------------
-  
+
   def config(options)
     @_config_reset = NPR.config
     NPR.config.merge(options)
   end
 
   #------------------
-  
+
   def reset_config
     NPR.instance_variable_set(:@config, @_config_reset)
   end
-  
+
   #------------------
-  
+
   def config!(options)
     config = NPR::Configuration.new(options)
     NPR.instance_variable_set(:@config, config)
   end
-  
+
   #------------------
-  
+
   def clear_config
     NPR.instance_variable_set(:@config, nil)
   end
-  
+
   #------------------
-  
+
   module ClassMethods
     # Merge the options into whatever the config
     # currently is, and reset it to its previous
@@ -42,12 +42,12 @@ module ConfigHelper
       before :all do
         config(options)
       end
-        
+
       after :all do
         reset_config
       end
     end
-    
+
     #--------------------
     # Set the config to ONLY the provided options,
     # and set to nil after.
@@ -55,7 +55,7 @@ module ConfigHelper
       before :all do
         config!(options)
       end
-        
+
       after :all do
         reset_config
       end

data/spec/support/fake_response.rb

@@ -6,7 +6,7 @@
 module FakeResponse
   #---------------------
   # Takes the filename to respond with,
-  # and (optionally) any options to be passed to 
+  # and (optionally) any options to be passed to
   # +FakeWeb.register_uri+.
   #
   # If no block is given, the registry will not be cleaned
@@ -17,34 +17,34 @@ module FakeResponse
   #
   def mock_response(filename, options={}, &block)
     respond_with(filename, options)
-    
+
     response = yield
     FakeWeb.clean_registry
-    
+
     response
   end
 
   #---------------------
-  # Register the NPR root with FakeWeb, and set its 
+  # Register the NPR root with FakeWeb, and set its
   # response body to the contents of the requested file.
   def respond_with(filename, options)
     content_type = options[:content_type] || "application/json"
     uri          = options.delete(:uri) || %r{^#{NPR::Configuration::API_ROOT}}
 
-    FakeWeb.register_uri(:get, uri, 
-      { 
+    FakeWeb.register_uri(:get, uri,
+      {
         :body         => load_fixture(filename),
         :content_type => content_type
       }.merge(options))
   end
-  
+
   #---------------------
   # Read a fixure file
   def load_fixture(filename)
     file = filename == :random ? random_filename : filename
     File.read(File.join FIXTURE_ROOT, file)
   end
-  
+
   #---------------------
   # Select a random response fixture
   def random_filename

data/spec/support/fixture_helper.rb

@@ -7,14 +7,14 @@ module FixtureHelper
   def self.included(base)
     base.extend ClassMethods
   end
-  
+
   module ClassMethods
     def json_fixture(&block)
       before :all do
         @json = yield
         @fixture = JSON.parse(@json)
       end
-      
+
       after :all do
         @json, @fixture = nil, nil
       end

data/spec/unit/api/query_builder_spec.rb

@@ -12,7 +12,7 @@ describe NPR::API::QueryBuilder do
         :id         => 5 ,
         :sort       => "date descending",
         :numResults => 10,
-        :startNum   => 100
+        :startNum   => 101
       ]
     end
 
@@ -173,6 +173,11 @@ describe NPR::API::QueryBuilder do
     it "returns itself" do
       @builder.offset(0).should eq @builder
     end
+
+    it "sets the startNum to value + 1" do
+      @builder.offset(100)
+      @builder.to_params[:startNum].should eq 101
+    end
   end
 
   #----------------------

data/spec/unit/entity/audio_spec.rb

@@ -66,7 +66,7 @@ describe NPR::Entity::Audio do
   end
 
   it "sets stream" do
-    @audio.stream.should eq false
+    @audio.stream.should be_a NPR::Entity::Stream
   end
 
   it "sets format" do

data/spec/unit/entity/formats_spec.rb

@@ -38,4 +38,9 @@ describe NPR::Entity::Formats do
     @formats.mp3s.size.should eq 2
     @formats.mp3s.first.should be_a NPR::Entity::MP3
   end
+
+  it 'blank? is true if JSON was empty' do
+    formats = NPR::Entity::Formats.new(JSON.parse("{}"))
+    formats.empty?.should eq true
+  end
 end

data/spec/unit/entity/stream_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe NPR::Entity::Name do
+  json_fixture do
+    <<-JSON
+      {
+        "active": "true"
+      }
+    JSON
+  end
+
+  before :each do
+    @stream = NPR::Entity::Stream.new(@fixture)
+  end
+
+  it "sets attributes" do
+    @stream.active.should eq true
+    @stream.active?.should eq true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: npr
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249174674460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.8.0
+  version_requirements: *70249174674460
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249174673960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+  version_requirements: *70249174673960
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249174660180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *70249174660180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249174659800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249174659800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249174659340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249174659340
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70249174658920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,12 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70249174658920
 description: NPR (npr.org) is a news organization. This gem helps you pull NPR content
   with a nice Ruby DSL.
 email:
@@ -169,6 +139,7 @@ files:
 - lib/npr/entity/related_link.rb
 - lib/npr/entity/show.rb
 - lib/npr/entity/story.rb
+- lib/npr/entity/stream.rb
 - lib/npr/entity/text.rb
 - lib/npr/entity/title.rb
 - lib/npr/entity/transcript.rb
@@ -269,6 +240,7 @@ files:
 - spec/unit/entity/related_link_spec.rb
 - spec/unit/entity/show_spec.rb
 - spec/unit/entity/story_spec.rb
+- spec/unit/entity/stream_spec.rb
 - spec/unit/entity/text_spec.rb
 - spec/unit/entity/title_spec.rb
 - spec/unit/entity/transcript_spec.rb
@@ -293,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A Ruby client for the NPR API
@@ -392,7 +364,7 @@ test_files:
 - spec/unit/entity/related_link_spec.rb
 - spec/unit/entity/show_spec.rb
 - spec/unit/entity/story_spec.rb
+- spec/unit/entity/stream_spec.rb
 - spec/unit/entity/text_spec.rb
 - spec/unit/entity/title_spec.rb
 - spec/unit/entity/transcript_spec.rb
-has_rdoc: