npr 0.0.0 → 0.1.0

data/spec/fixtures/rss/06_story_multiple_ids.rss

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss xmlns:npr="http://www.npr.org/rss/" xmlns:nprml="http://api.npr.org/nprml" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:content="http://purl.org/rss/1.0/modules/content/" version="2.0">
+  <channel>
+    <title>NPR: Stories from NPR</title>
+    <link>http://www.npr.org</link>
+    <description>Assorted stories from NPR</description>
+    <language>en</language>
+    <copyright>Copyright 2012 NPR - For Personal Use Only</copyright>
+    <generator>NPR API RSS Generator 0.94</generator>
+    <lastBuildDate>Thu, 13 Dec 2012 14:53:00 -0500</lastBuildDate>
+    <image>
+      <url>http://media.npr.org/images/npr_news_123x20.gif</url>
+      <title>NPR: Stories from NPR</title>
+      <link>http://www.npr.org</link>
+    </image>
+    <item>
+      <title>Why Legos Are So Expensive — And So Popular</title>
+      <description>Legos often cost twice as much as similar blocks from a rival toymaker. So why are Legos so much more popular than other brands?</description>
+      <pubDate>Thu, 13 Dec 2012 14:53:00 -0500</pubDate>
+      <link>http://www.npr.org/blogs/money/2012/12/13/167055503/why-legos-are-so-expensive-and-so-popular?ft=1&amp;f=166956822,167055503</link>
+      <guid>http://www.npr.org/blogs/money/2012/12/13/167055503/why-legos-are-so-expensive-and-so-popular?ft=1&amp;f=166956822,167055503</guid>
+      <content:encoded><![CDATA[<p>Legos often cost twice as much as similar blocks from a rival toymaker. So why are Legos so much more popular than other brands?</p><p><a href="http://www.npr.org/templates/email/emailAFriend.php?storyId=167055503">&raquo; E-Mail This</a>&nbsp;&nbsp;&nbsp;&nbsp; <a href="http://del.icio.us/post?url=http%3A%2F%2Fwww.npr.org%2Ftemplates%2Fstory%2Fstory.php%3FstoryId%3D167055503">&raquo; Add to Del.icio.us</a></p>]]></content:encoded>
+    </item>
+    <item>
+      <title>How The Rich Feel About Paying More Taxes</title>
+      <description>Many people earning more than $250,000 a year — the 2 percent — admit they can afford to pay more in taxes. However, they don't necessarily like the idea, especially when they're made to feel like skinflints even though they're already sending significant sums to Washington.</description>
+      <pubDate>Thu, 13 Dec 2012 11:22:00 -0500</pubDate>
+      <link>http://www.npr.org/2012/12/11/166956822/how-the-rich-feel-about-paying-more-taxes?ft=1&amp;f=166956822,167055503</link>
+      <guid>http://www.npr.org/2012/12/11/166956822/how-the-rich-feel-about-paying-more-taxes?ft=1&amp;f=166956822,167055503</guid>
+      <content:encoded><![CDATA[<p>Many people earning more than $250,000 a year — the 2 percent — admit they can afford to pay more in taxes. However, they don't necessarily like the idea, especially when they're made to feel like skinflints even though they're already sending significant sums to Washington.</p><p><a href="http://www.npr.org/templates/email/emailAFriend.php?storyId=166956822">&raquo; E-Mail This</a>&nbsp;&nbsp;&nbsp;&nbsp; <a href="http://del.icio.us/post?url=http%3A%2F%2Fwww.npr.org%2Ftemplates%2Fstory%2Fstory.php%3FstoryId%3D166956822">&raquo; Add to Del.icio.us</a></p>]]></content:encoded>
+    </item>
+  </channel>
+</rss>

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'bundler/setup'
+Bundler.require
+
+SPEC_ROOT    = File.dirname(__FILE__)
+FIXTURE_ROOT = File.join SPEC_ROOT, "fixtures"
+
+# Require the support files
+Dir["#{SPEC_ROOT}/support/**/*.rb"].each { |f| require f }
+
+# Disallow real network connections
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+
+# Configuration
+RSpec.configure do |config|
+  config.include FakeResponse
+  config.include ConfigHelper
+  config.include FixtureHelper
+  
+  config.before do
+    FakeWeb.clean_registry
+  end
+end

data/spec/support/config_helper.rb

@@ -0,0 +1,64 @@
+##
+# ConfigHelper
+#
+module ConfigHelper
+  def self.included(base)
+    base.extend ClassMethods
+  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
+    # state after.
+    def config(options)
+      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.
+    def config!(options)
+      before :all do
+        config!(options)
+      end
+        
+      after :all do
+        reset_config
+      end
+    end
+  end
+end

data/spec/support/fake_response.rb

@@ -0,0 +1,54 @@
+##
+# FakeResponse
+#
+# Helpers for faking responses from the API
+#
+module FakeResponse
+  #---------------------
+  # Takes the filename to respond with,
+  # and (optionally) any options to be passed to 
+  # +FakeWeb.register_uri+.
+  #
+  # If no block is given, the registry will not be cleaned
+  # by this method.
+  #
+  # If passed a block, it will clean the registry after
+  # the block has been run.
+  #
+  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 
+  # response body to the contents of the requested file.
+  def respond_with(filename, options)
+    content_type = options[:content_type] || "application/json"
+    
+    FakeWeb.register_uri(:get, 
+      %r{^#{NPR::Configuration::API_ROOT}}, 
+      { :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
+    filename = Dir["#{FIXTURE_ROOT}/**/*story*.rb"].sample
+    puts "Responding with #{filename}"
+    filename
+  end
+end # FakeResponse

data/spec/support/fixture_helper.rb

@@ -0,0 +1,23 @@
+##
+# FixtureHelper
+#
+# Helps with doing inline fixtures for JSON strings
+#
+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
+    end
+  end
+end

data/spec/unit/api/client_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe NPR::API::Client do
+  describe "params" do
+    it "sets @apiKey on initialize and removes it from the params if passed in" do
+      client = NPR::API::Client.new(:apiKey => "key")
+      client.instance_variable_get(:@apiKey).should eq "key"
+      client.params.keys.should_not include :apiKey
+    end
+    
+    it "uses global config" do
+      NPR.config.sort = "super sort"
+      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 "raises NotConfiguredError if apiKey is blank" do
+      client = NPR::API::Client.new
+      lambda { client.query }.should raise_error NPR::NotConfiguredError
+    end
+    
+    context "nprml" do
+      it "returns a result in hash format" do
+      end
+    end
+    
+    context "json" do
+      it "returns a result in hash format" do
+      end
+    end    
+  end
+end

data/spec/unit/api/message_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe NPR::API::Message do
+  describe "warning" do
+    json_fixture do
+      <<-JSON
+        {
+          "id": "203",
+          "level": "warning",
+          "text": {
+            "$text": "Query parameter id='000' is invalid because it is not an integer and was ignored."
+          },
+          "timestamp": {
+            "$text": "1355552691.56"
+          }
+        }
+      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
+        {
+          "id": "310",
+          "level": "error",
+          "text": {
+            "$text": "The API key passed in () was invalid or no API key was passed in.  Please register for a valid API key."
+          },
+          "timestamp": {
+            "$text": "1355554389.89"
+          }
+        }
+      JSON
+    end
+    
+    before :each do
+      @message = NPR::API::Message.new(@fixture)
+    end
+    
+    it "is an error" do
+      @message.error?.should eq true
+    end
+  end
+end

data/spec/unit/api/query_builder_spec.rb

@@ -0,0 +1,195 @@
+require "spec_helper"
+
+describe NPR::API::QueryBuilder do
+  describe "#to_params" 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[
+        :id         => 5 ,
+        :sort       => "date descending",
+        :numResults => 10,
+        :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
+  
+  #----------------------
+  
+  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)
+
+      @builder.builder.should eq Hash[
+        :conditions => {
+          :id     => 9999,
+          :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[
+        :conditions => { :id => 5 },
+        :order      => "date descending",
+        :limit      => 10,
+        :offset     => 100
+      ]
+    end
+  end
+end

data/spec/unit/api/response_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require "json"
+
+describe NPR::API::Response do
+  before :each do
+    @client = NPR::API::Client.new(:apiKey => "key")
+  end
+  
+  describe "messages" do
+    it "generates messages" do
+      response = mock_response "json/04_invalid_id.json" do
+        @client.query(:id => 999)
+      end
+      
+      response.messages.size.should eq 1
+      response.messages.first.id.should eq "201"
+    end
+    
+    it "adds the messages association even if there aren't any" do
+      response = mock_response "json/01_story_full_media.json" do
+        @client.query(:id => 999)
+      end
+    
+      response.messages.should eq []
+    end
+  end
+  
+  describe "list" do
+    it "is generated" do
+      response = mock_response "json/01_story_full_media.json" do
+        @client.query(:id => 999)
+      end
+    
+      response.list.should be_a NPR::Entity::List
+    end
+  
+    it "isn't generated no list node was present" do
+      response = mock_response "json/05_no_api_key.json" do
+        @client.query(:id => 999)
+      end
+    
+      response.list.should eq nil
+    end
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe NPR::Configuration do
+  describe "NPR.configure" do
+    after :each do
+      NPR.instance_variable_set :@config, nil
+    end
+    
+    it "takes a block to set global configuration" do
+      NPR.configure do |config|
+        config.sort = "cool sorting, bro"
+      end
+    
+      NPR.config.sort.should eq "cool sorting, bro"
+      NPR.config.apiKey.should eq nil
+    end
+  end
+  
+  describe "NPR.config" do
+    it "creates a new NPR::Configure object" do
+      config = NPR.config
+      config.should be_a NPR::Configuration
+      NPR.config.should equal config 
+    end
+  end
+  
+  #------------------
+  
+  describe "with options" do
+    it "assigns the passed-in options using the setter" do
+      config = NPR::Configuration.new(:apiKey => "hello")
+      config.apiKey.should eq "hello"
+    end
+  end
+  
+  #------------------
+  
+  describe "#to_hash" do
+    it "converts the config to a hash" do
+      config = NPR::Configuration.new
+      config.sort   = "date"
+      config.apiKey = "key"
+  
+      config.to_hash.should eq Hash[:sort => "date", :apiKey => "key"]
+    end
+  end
+  
+  #------------------
+  
+  describe "#merge" do
+    it "turns it into a hash and merges it with the passed-in hash" do
+      config = NPR::Configuration.new
+      config.sort   = "date"
+      config.apiKey = "key"
+      
+      config.merge(:title => "List").should eq Hash[
+        :title => "List",
+        :sort => "date", 
+        :apiKey => "key" 
+      ]
+    end
+  end
+end

data/spec/unit/entity/audio_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe NPR::Entity::Audio do
+  json_fixture do
+    <<-JSON
+      {
+        "id": "167255688",
+        "type": "primary",
+        "title": {},
+        "duration": {
+          "$text": "465"
+        },
+        "description": {},
+        "format": {
+          "mp3": [
+            {
+              "type": "mp3",
+              "$text": "http://pd.npr.org/anon.npr-mp3/npr/totn/2012/12/20121214_totn_01.mp3?orgId=1&topicId=1007&ft=3&f="
+            },
+            {
+              "type": "m3u",
+              "$text": "http://api.npr.org/m3u/1167255688-5265f3.m3u?orgId=1&topicId=1007&ft=3&f="
+            }
+          ],
+          "wm": {
+            "$text": "http://www.npr.org/templates/dmg/dmg_wmref_em.php?id=167255688&type=1&mtype=WM&orgId=1&topicId=1007&ft=3&f="
+          },
+          "mediastream": {
+            "$text": "rtmp://flash.npr.org/ondemand/mp3:anon.npr-mp3/npr/totn/2012/12/20121214_totn_01.mp3"
+          }
+        },
+        "rightsHolder": {},
+        "permissions": {
+          "download": {
+            "allow": "true"
+          },
+          "stream": {
+            "allow": "true"
+          },
+          "embed": {
+            "allow": "true"
+          }
+        },
+        "stream": {
+          "active": "false"
+        }
+      }
+    JSON
+  end
+  
+  before :each do
+    @audio = NPR::Entity::Audio.new(@fixture)
+  end
+  
+  it "sets attributes" do
+    @audio.id.should eq 167255688
+    @audio.type.should eq "primary"
+    @audio.title.should eq ""
+    @audio.duration.should eq 465
+    @audio.description.should eq ""
+    @audio.rightsHolder.should eq ""
+  end
+  
+  it "sets permissions" do
+    @audio.permissions.should be_a NPR::Entity::Permissions
+  end
+  
+  it "sets stream" do
+    @audio.stream.should eq false
+  end
+  
+  it "sets format" do
+    @audio.formats.should be_a NPR::Entity::Formats
+  end  
+end