ap 0.1.1

data/lib/ap/version.rb

@@ -0,0 +1,3 @@
+module AP
+  VERSION = '0.1.1'.freeze
+end

data/spec/ap/api_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe AP::API do
+  describe "base_uri" do
+    it "should have the correct endpoint" do
+      AP::API.base_uri.should == "http://developerapi.ap.org"
+    end
+  end
+  
+  describe "format" do
+    it "should have the custom ap_xml format" do
+      AP::API.format.should be(:ap_xml)
+    end
+  end
+  
+  describe "API key" do
+    it "should have a apiKey key in the default params hash" do
+      AP::API.new
+      AP::API.default_params.keys.should include(:apiKey)
+    end
+  end
+end

data/spec/ap/article_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe AP::Article do
+  describe "attributes" do
+    [:id, :title, :authors, :tags, :link, :content, :updated].each do |e|
+      it "should have a #{e} attribute" do
+        @article = AP::Article.new
+        @article.should respond_to(e)
+      end
+    end
+    
+    params_hash = {:id => "random", :title => "a title", :authors => "", :tags => ["A tag"], :link => "http://google.com", :content => "<div>content</div>", :updated => Time.now}
+    params_hash.each do |e, v|
+      it "should have the correct value for #{e}" do
+        @article = AP::Article.new(params_hash)
+        @article.send(e).should == v
+      end
+    end    
+  end
+  
+  describe "creating an object from API data" do
+    before do
+      @api_data = {
+        "id" => "urn:blah:blahblah",
+        "title" => "Hello",
+        "author" => [],
+        "category" => [ {"label" => "Tag 1"}, {"label" => "Tag 2" } ],
+        "link" => { "href" => "http://google.com" },
+        "content" => "<div>content</div>",
+        "updated" => "2011-04-23T06:00:39Z"
+      }
+      @parsed_data = {
+        "id" => "blahblah",
+        "title" => "Hello",
+        "authors" => [],
+        "tags" => ["Tag 1", "Tag 2"],
+        "link" => "http://google.com",
+        "content" => "<div>content</div>",
+        "updated" => Time.parse("2011-04-23T06:00:39Z")
+      }
+    end
+    
+    describe "should return a proper object" do
+      before do
+        @article = AP::Article.new_from_api_data(@api_data)
+      end
+      
+      [:id, :title, :authors, :tags, :link, :content, :updated].each do |e|
+        it "with the correct value for #{e.to_s}" do
+          @article.send(e).should == @parsed_data[e.to_s]
+        end
+      end
+    end
+    
+    describe "should properly differentiate between one and multiple authors" do
+      before do
+        @api_data["author"] = {"name" => "Joe"}
+        @parsed_data["authors"] = ["Joe"]
+        @article = AP::Article.new_from_api_data(@api_data)
+      end
+      
+      [:id, :title, :authors, :tags, :link, :content, :updated].each do |e|
+        it "with the correct value for #{e.to_s}" do
+          @article.send(e).should == @parsed_data[e.to_s]
+        end
+      end
+    end
+    
+    describe "should support multiple authors" do
+      before do
+        @api_data["author"] = [{"name" => "Joe"}, {"name" => "Bob"}, {"name" => "Jane"}]
+        @parsed_data["authors"] = ["Joe", "Bob", "Jane"]
+        @article = AP::Article.new_from_api_data(@api_data)
+      end
+      
+      [:id, :title, :authors, :tags, :link, :content, :updated].each do |e|
+        it "with the correct value for #{e.to_s}" do
+          @article.send(e).should == @parsed_data[e.to_s]
+        end
+      end
+    end
+  end
+end

data/spec/ap/category_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe AP::Category do
+  describe "attributes" do
+    [:id, :title, :content, :updated].each do |e|
+      it "should have a #{e} attribute" do
+        @category = AP::Category.new
+        @category.should respond_to(e)
+      end
+    end
+    
+    params_hash = {:id => "random", :title => "a title", :content => "<div>content</div>", :updated => Time.now }
+    params_hash.each do |e, v|
+      it "should have the correct value for #{e}" do
+        @category = AP::Category.new(params_hash)
+        @category.send(e).should == v
+      end
+    end    
+  end
+  
+  describe "creating an object from API data" do
+    before do
+      @api_data = {
+        "id" => "urn:uuid:31990",
+        "title" => "Hello",
+        "content" => "<div>content</div>",
+        "updated" => "2011-04-23T06:00:39Z"
+      }
+      @parsed_data = {
+        "id" => "31990",
+        "title" => "Hello",
+        "content" => "<div>content</div>",
+        "updated" => Time.parse("2011-04-23T06:00:39Z")
+      }
+    end
+    
+    describe "should return a proper object" do
+      before do
+        @category = AP::Category.new_from_api_data(@api_data)
+      end
+      
+      [:id, :title, :content, :updated].each do |e|
+        it "with the correct value for #{e.to_s}" do
+          @category.send(e).should == @parsed_data[e.to_s]
+        end
+      end
+    end
+    
+  end
+end

data/spec/ap/client/category_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe AP::Client::Category do
+  context "with an API key" do
+    before do
+      AP.configure do |c|
+        c.api_key = "api"
+      end
+    end
+    
+    describe ".categories" do
+      before do
+        stub_get("/v2/categories.svc/?apiKey=api").to_return(:body => fixture("categories.xml"), :headers => {:content_type => "application/xml; charset=utf-8"})
+      end
+    
+      it "should map API data to objects" do
+        AP.categories.size.should == 52
+      end
+    
+      {:id => "31990", :content => "AP Online Top General Short Headlines", :title => "AP Online Top General Short Headlines", :updated => Time.parse("2011-04-23T05:55:23Z") }.each do |e, v|
+        it "should map the API data to the attribute #{e}" do
+          AP.categories.first.send(e).should == v
+        end
+      end
+    end
+  
+    describe ".category(id)" do
+      before do
+        stub_get("/v2/categories.svc/31990?apiKey=api").to_return(:body => fixture("categories-31990.xml"), :headers => {:content_type => "application/xml; charset=utf-8"})
+      end
+    
+      it "should map API data to objects" do
+        AP.category(31990).size.should == 10
+      end
+    
+      {
+        :id => "772cbfbd-eb16-4527-882e-48d4fb21ad35",
+        :title => "Tornado causes injuries at St. Louis airport",
+        :updated => Time.parse("2011-04-23T05:48:58Z"),
+        :authors => ["JIM SALTER", "JIM SUHR"],
+        :link => "http://hosted2.ap.org/APDEFAULT/Article_2011-04-23-US-Missouri-Storms/id-p772cbfbdeb164527882e48d4fb21ad35",
+        :tags => [ "Property damage", "Tornados", "Power outages", "Storms", "Natural disasters", "Weather", "Air travel disruptions", "Emergency management",
+                      "Injuries", "General news", "Tornados", "Accidents and disasters", "Transportation", "Government and politics", "Health", "Francis Slay",
+                      "Jay Nixon", "Maryland", "St. Louis", "Missouri", "United States", "North America"]
+      }.each do |e, v|
+        it "should map the API data to the attribute #{e}" do
+          AP.category(31990).first.send(e).should == v
+        end
+      end
+    end
+  end
+  
+  context "without an API key" do
+    before do
+      AP.configure do |c|
+        c.api_key = nil
+      end
+    end
+    
+    describe ".categories" do
+      it "should raise a MissingAPIKeyError" do
+        stub_get("/v2/categories.svc/?apiKey=api").to_return(:status => 200, :body => "403 Developer Inactive", :headers => {})
+        expect { AP.categories }.to raise_error(AP::API::MissingAPIKeyError)
+      end
+    end
+  
+    describe ".category(id)" do
+      it "should raise a MissingAPIKeyError" do
+        stub_get("/v2/categories.svc/5?apiKey=api").to_return(:status => 200, :body => "", :headers => {})
+        expect { AP.category(5) }.to raise_error(AP::API::MissingAPIKeyError)
+      end
+    end
+  end
+end

data/spec/ap/client_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AP::Client do
+  describe "includes AP::Client::Category" do
+    before do
+      @client = AP::Client.new
+    end
+    
+    [:categories, :category].each do |e|
+      it "should respond to #{e}" do
+        @client.should respond_to(e)
+      end
+    end
+  end
+end

data/spec/ap/parser_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe HTTParty::Parser do
+  
+  it "should add CDATA tags and parse correctly" do
+    parsed = HTTParty::Parser.call("<feed xmlns=\"http://www.w3.org/2005/Atom\"><entry><content type=\"xhtml\"><div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hnews hentry item\"></div></div></content></entry></feed>", :ap_xml)
+    parsed["feed"]["entry"]["content"].should == "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hnews hentry item\"></div></div>"
+  end
+  
+  it "shouldn't add CDATA when not needed" do
+    parsed = HTTParty::Parser.call("<feed xmlns=\"http://www.w3.org/2005/Atom\"><entry><content type=\"xhtml\"><![CDATA[<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hnews hentry item\"></div></div>]]></content></entry></feed>", :ap_xml)
+    parsed["feed"]["entry"]["content"].should == "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hnews hentry item\"></div></div>"
+  end
+end

data/spec/ap/search_spec.rb

@@ -0,0 +1,453 @@
+require 'spec_helper'
+
+describe AP::Search do
+  # similar queries
+  describe "similar query" do
+    before do
+      @search = AP::Article.new(:id => "5").similar
+    end
+    
+    describe ".clear" do
+      before do
+        @search.clear
+      end
+      
+      it "should reset the search type to request" do
+        @search.search_type.should == "request"
+      end
+      
+      it "should reset the search terms" do
+        @search.query[:searchTerms].should == []
+      end
+      
+      it "should reset the start page" do
+        @search.query[:startPage].should == 1
+      end
+      
+      it "should reset the count" do
+        @search.query[:count].should == 20
+      end
+    end
+    
+    describe ".containing" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.containing("Obama") }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".exact" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.exact("Obama") }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".matches" do
+      it "should raise an UnsupportedSearchMethod error" do
+         expect { @search.matches("Ira") }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".loose_match" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.loose_match("ira") }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".geocode" do
+      it "should properly set the geocode attributes given lat & long" do
+        @search.geocode(50, -125)
+        @search.query[:latitude].should == 50
+        @search.query[:longitude].should == -125
+        @search.query[:radius].should == 50
+      end
+      
+      it "should properly set the geocode attributes given lat, long & radius" do
+        @search.geocode(50, -125, 35)
+        @search.query[:latitude].should == 50
+        @search.query[:longitude].should == -125
+        @search.query[:radius].should == 35
+      end
+      
+      it "should raise a InvalidGeocodinates when latitude is invalid" do
+        expect { @search.geocode(100, 0) }.to raise_error(AP::Search::InvalidGeocodinates)
+      end
+      
+      it "should raise a InvalidGeocodinates when longitude is invalid" do
+        expect { @search.geocode(50, 200) }.to raise_error(AP::Search::InvalidGeocodinates)
+      end
+      
+      it "should raise a InvalidGeocodinates when longitude and latitude are invalid" do
+        expect { @search.geocode(-95, 200) }.to raise_error(AP::Search::InvalidGeocodinates)
+      end
+    end
+    
+    describe ".location" do
+      it "should set City, State & ZIP code when given" do
+        @search.location(:zip_code => 12345, :city => "Albany", :state => "NY")
+        @search.query[:location].should == "Albany, NY, 12345"
+      end
+      
+      it "should set ZIP code when given" do
+        @search.location(:zip_code => 12345)
+        @search.query[:location].should == "12345"
+      end
+      
+      it "should only set ZIP code if City is also given" do
+        @search.location(:zip_code => 12345, :city => "Albany")
+        @search.query[:location].should == "12345"
+      end
+      
+      it "should only set ZIP code if State is also given" do
+        @search.location(:zip_code => 12345, :state => "NY")
+        @search.query[:location].should == "12345"
+      end
+      
+      it "should set City & State if both are given" do
+        @search.location(:city => "Albany", :state => "NY")
+        @search.query[:location].should == "Albany, NY"
+      end
+    end
+    
+    describe ".sort_by_location" do
+      it "should default to true" do
+        @search.sort_by_location
+        @search.query[:sortByLocation].should be(true)
+      end
+      
+      it "should take the parameter true" do
+        @search.sort_by_location(true)
+        @search.query[:sortByLocation].should be(true)
+      end
+      
+      it "should take the parameter false" do
+        @search.sort_by_location(false)
+        @search.query[:sortByLocation].should be(false)
+      end
+    end
+    
+    describe ".scoped" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.scoped do |c|; end; }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".and" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.and }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".or" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.or }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".and_not" do
+      it "should raise an UnsupportedSearchMethod error" do
+        expect { @search.and_not }.to raise_error(AP::Search::UnsupportedSearchMethod)
+      end
+    end
+    
+    describe ".per_page" do
+      it "should default to 20" do
+        @search.per_page
+        @search.query[:count].should == 20
+      end
+      
+      it "should set the sent value" do
+        @search.per_page(39)
+        @search.query[:count].should == 39
+      end
+    end
+    
+    describe ".page" do
+      it "should default to 1" do
+        @search.page
+        @search.query[:startPage].should == 1
+      end
+      
+      it "should move to the sent page" do
+        @search.page(5)
+        @search.query[:startPage].should == 5
+      end
+    end
+  end
+  
+  # request queries
+  describe "request query" do
+    before do
+      @search = AP::Search.new
+    end
+    
+    describe ".clear" do
+      before do
+        @search.clear
+      end
+      
+      it "should keep the search type at request" do
+        @search.search_type.should == "request"
+      end
+      
+      it "should reset the search terms" do
+        @search.query[:searchTerms].should == []
+      end
+      
+      it "should reset the start page" do
+        @search.query[:startPage].should == 1
+      end
+      
+      it "should reset the count" do
+        @search.query[:count].should == 20
+      end
+    end
+    
+    describe ".containing" do
+      it "should append the string the the query" do
+        @search.containing("Obama")
+        @search.query[:searchTerms].first.should == "Obama"
+      end
+    end
+    
+    describe ".exact" do
+      it "should append the string the the query" do
+        @search.exact("Obama")
+        @search.query[:searchTerms].first.should == "\"Obama\""
+      end
+    end
+    
+    describe ".matches" do
+      it "should append the string the the query" do
+        @search.matches("Ira")
+        @search.query[:searchTerms].first.should == "Ira?"
+      end
+    end
+    
+    describe ".loose_match" do
+      it "should append the string the the query" do
+        @search.loose_match("ira")
+        @search.query[:searchTerms].first.should == "ira*"
+      end
+    end
+    
+    describe ".geocode" do
+      it "should properly set the geocode attributes given lat & long" do
+        @search.geocode(50, -125)
+        @search.query[:latitude].should == 50
+        @search.query[:longitude].should == -125
+        @search.query[:radius].should == 50
+      end
+      
+      it "should properly set the geocode attributes given lat, long & radius" do
+        @search.geocode(50, -125, 35)
+        @search.query[:latitude].should == 50
+        @search.query[:longitude].should == -125
+        @search.query[:radius].should == 35
+      end
+      
+      it "should raise a InvalidGeocodinates when latitude is invalid" do
+        expect { @search.geocode(100, 0) }.to raise_error(AP::Search::InvalidGeocodinates)
+      end
+      
+      it "should raise a InvalidGeocodinates when longitude is invalid" do
+        expect { @search.geocode(50, 200) }.to raise_error(AP::Search::InvalidGeocodinates)
+      end
+      
+      it "should raise a InvalidGeocodinates when longitude and latitude are invalid" do
+        expect { @search.geocode(-95, 200) }.to raise_error(AP::Search::InvalidGeocodinates)
+      end
+    end
+    
+    describe ".location" do
+      it "should set City, State & ZIP code when given" do
+        @search.location(:zip_code => 12345, :city => "Albany", :state => "NY")
+        @search.query[:location].should == "Albany, NY, 12345"
+      end
+      
+      it "should set ZIP code when given" do
+        @search.location(:zip_code => 12345)
+        @search.query[:location].should == "12345"
+      end
+      
+      it "should only set ZIP code if City is also given" do
+        @search.location(:zip_code => 12345, :city => "Albany")
+        @search.query[:location].should == "12345"
+      end
+      
+      it "should only set ZIP code if State is also given" do
+        @search.location(:zip_code => 12345, :state => "NY")
+        @search.query[:location].should == "12345"
+      end
+      
+      it "should set City & State if both are given" do
+        @search.location(:city => "Albany", :state => "NY")
+        @search.query[:location].should == "Albany, NY"
+      end
+    end
+    
+    describe ".sort_by_location" do
+      it "should default to true" do
+        @search.sort_by_location
+        @search.query[:sortByLocation].should be(true)
+      end
+      
+      it "should take the parameter true" do
+        @search.sort_by_location(true)
+        @search.query[:sortByLocation].should be(true)
+      end
+      
+      it "should take the parameter false" do
+        @search.sort_by_location(false)
+        @search.query[:sortByLocation].should be(false)
+      end
+    end
+    
+    describe ".and" do
+      it "should append AND only if something already is in the query" do
+        @search.contains("Obama").and
+        @search.query[:searchTerms].last.should == "AND"
+      end
+      
+      it "shouldn't append if the query is empty" do
+        @search.and
+        @search.query[:searchTerms].last.should == nil
+      end
+      
+      it "shouldn't append if the last item in the query was AND" do
+        @search.contains("Obama").and.and
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "AND"
+        @search.query[:searchTerms].size.should == 2
+      end
+      
+      it "shouldn't append if the last item in the query was OR" do
+        @search.contains("Obama").or.and
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "OR"
+        @search.query[:searchTerms].size.should == 2
+      end
+      
+      it "shouldn't append if the last item in the query was AND NOT" do
+        @search.contains("Obama").and_not.and
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "AND NOT"
+        @search.query[:searchTerms].size.should == 2
+      end
+    end
+    
+    describe ".or" do
+      it "should append OR only if something already is in the query" do
+        @search.contains("Obama").or
+        @search.query[:searchTerms].last.should == "OR"
+      end
+
+      it "shouldn't append if the query is empty" do
+        @search.or
+        @search.query[:searchTerms].last.should == nil
+      end
+
+      it "shouldn't append if the last item in the query was OR" do
+        @search.contains("Obama").or.or
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "OR"
+        @search.query[:searchTerms].size.should == 2
+      end
+      it "shouldn't append if the last item in the query was AND" do
+        @search.contains("Obama").and.or
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "AND"
+        @search.query[:searchTerms].size.should == 2
+      end
+      
+      it "shouldn't append if the last item in the query was AND NOT" do
+        @search.contains("Obama").and_not.or
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "AND NOT"
+        @search.query[:searchTerms].size.should == 2
+      end
+    end
+    
+    describe ".and_not" do
+      it "should append AND NOT only if something already is in the query" do
+        @search.contains("Obama").and_not
+        @search.query[:searchTerms].last.should == "AND NOT"
+      end
+
+      it "shouldn't append if the query is empty" do
+        @search.and_not
+        @search.query[:searchTerms].last.should == nil
+      end
+      
+      it "shouldn't append if the last item in the query was AND" do
+        @search.contains("Obama").and.and_not
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "AND"
+        @search.query[:searchTerms].size.should == 2
+      end
+      
+      it "shouldn't append if the last item in the query was OR" do
+        @search.contains("Obama").or.and_not
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "OR"
+        @search.query[:searchTerms].size.should == 2
+      end
+      
+      it "shouldn't append if the last item in the query was AND NOT" do
+        @search.contains("Obama").and_not.and_not
+        @search.query[:searchTerms].first.should == "Obama"
+        @search.query[:searchTerms].last.should == "AND NOT"
+        @search.query[:searchTerms].size.should == 2
+      end
+    end
+    
+    describe ".per_page" do
+      it "should default to 20" do
+        @search.per_page
+        @search.query[:count].should == 20
+      end
+      
+      it "should set the sent value" do
+        @search.per_page(39)
+        @search.query[:count].should == 39
+      end
+    end
+    
+    describe ".page" do
+      it "should default to 1" do
+        @search.page
+        @search.query[:startPage].should == 1
+      end
+      
+      it "should move to the sent page" do
+        @search.page(5)
+        @search.query[:startPage].should == 5
+      end
+    end
+  end
+  
+  context "without an API key" do
+    before do
+      @search = AP::Search.new      
+    end
+    
+    it "should raise a MissingAPIKeyError" do
+      @search.contains("Obama")
+      expect { @search.fetch }.to raise_error(AP::API::MissingAPIKeyError)
+    end
+  end
+  
+  context "with an API key" do
+    before do
+      AP.configure do |c|
+        c.api_key = "api"
+      end
+      @search = AP::Search.new
+      stub_get("/v2/search.svc/request/?apiKey=api&count=20&searchTerms=Obama&startPage=1").to_return(:body => fixture("search-obama.xml"), :headers => {:content_type => "application/xml; charset=utf-8"})
+    end
+    
+    it "should fetch and return" do
+      @search.contains("Obama")
+      @search.fetch.size.should == 20
+    end
+  end
+end