citygrid_api 0.0.21 → 0.0.22

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
-gem "httparty", "~> 0.8.1"
-gem "json", "1.5.3"
+gem "httparty", ">= 0.8.1"
+gem "json", ">= 1.5.3"
 gem "riot", "~> 0.12.4"
 
 group :development do
@@ -10,6 +10,7 @@ group :development do
   gem "vcr"
   gem "webmock"
   gem 'rdoc'
+  gem 'rspec'
 end
 
 group :dashboard do

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     addressable (2.2.6)
     crack (0.3.1)
+    diff-lcs (1.1.3)
     git (1.2.5)
     haml (3.1.4)
     httparty (0.8.1)
@@ -25,6 +26,14 @@ GEM
     riot (0.12.5)
       rr
     rr (1.0.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
     sinatra (1.3.1)
       rack (~> 1.3, >= 1.3.4)
       rack-protection (~> 1.1, >= 1.1.2)
@@ -40,12 +49,13 @@ PLATFORMS
 
 DEPENDENCIES
   haml
-  httparty (~> 0.8.1)
+  httparty (>= 0.8.1)
   jeweler (~> 1.6.2)
-  json (= 1.5.3)
+  json (>= 1.5.3)
   rcov
   rdoc
   riot (~> 0.12.4)
+  rspec
   sinatra
   vcr
   webmock

data/README.rdoc

@@ -21,6 +21,12 @@ Add a file called citygrid_api.rb under config/initializers.
 Configure the gem to use your publisher code with:
 
    CityGrid.publisher = 'your_publisher_code'
+
+Additional options are available such as:
+
+   CityGrid.print_curls = true/false
+   CityGrid.custom_timeout = 20 #time in seconds
+   CityGrid.raise_errors = true/false
    
 If you don't have a publisher code, you can obtain one at http://developer.citygridmedia.com
 

data/VERSION

@@ -1 +1 @@
-0.0.21
+0.0.22

data/citygrid_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "citygrid_api"
-  s.version = "0.0.21"
+  s.version = "0.0.22"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elpizo Choi"]
-  s.date = "2012-10-22"
+  s.date = "2012-12-06"
   s.description = "Ruby wrapper for CityGrid APIs"
   s.email = "fu7iin@gmail.com"
   s.extra_rdoc_files = [
@@ -94,6 +94,7 @@ Gem::Specification.new do |s|
     "lib/citygrid/api/advertising/budget.rb",
     "lib/citygrid/api/advertising/call_detail.rb",
     "lib/citygrid/api/advertising/campaign.rb",
+    "lib/citygrid/api/advertising/campaign_promotions.rb",
     "lib/citygrid/api/advertising/category.rb",
     "lib/citygrid/api/advertising/geolocation.rb",
     "lib/citygrid/api/advertising/image.rb",
@@ -123,6 +124,8 @@ Gem::Specification.new do |s|
     "lib/request_ext.rb",
     "lib/string_ext.rb",
     "public/javascript/dashboard.js",
+    "spec/api_status_checks/content/listing_api_spec.rb",
+    "spec/spec_helper.rb",
     "test/api/accounts/test_account.rb",
     "test/api/accounts/test_method_of_payment.rb",
     "test/api/accounts/test_temp_impersonation.rb",
@@ -174,33 +177,36 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, ["~> 0.8.1"])
-      s.add_runtime_dependency(%q<json>, ["= 1.5.3"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.8.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.5.3"])
       s.add_runtime_dependency(%q<riot>, ["~> 0.12.4"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<vcr>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<httparty>, ["~> 0.8.1"])
-      s.add_dependency(%q<json>, ["= 1.5.3"])
+      s.add_dependency(%q<httparty>, [">= 0.8.1"])
+      s.add_dependency(%q<json>, [">= 1.5.3"])
       s.add_dependency(%q<riot>, ["~> 0.12.4"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<vcr>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<httparty>, ["~> 0.8.1"])
-    s.add_dependency(%q<json>, ["= 1.5.3"])
+    s.add_dependency(%q<httparty>, [">= 0.8.1"])
+    s.add_dependency(%q<json>, [">= 1.5.3"])
     s.add_dependency(%q<riot>, ["~> 0.12.4"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<vcr>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/citygrid_api.yml.sample

@@ -1,4 +1,5 @@
 defaults:
+  # QA
   hostname: api.qa.citygrid.com
   ssl_hostname: api-qassl.citygrid.com
 
@@ -38,22 +39,24 @@ api:
       endpoint: report/calldetail/v2
       hostname: lax1qatxpi4.test.cs:8080
     campaign: advertising/campaign/v2
+    campaign_promotions: advertising/campaign/v2/promo
     category: content/category/v2
     geo_location: content/places/v2/geocode
     image: advertising/image/v2
     offers: advertising/offer/v2
     places: content/places/v2
     performance: advertising/performance/v2
+
   content:
     offers:
       endpoint: content/offers/v2
-      hostname: api.citygridmedia.com
+      hostname: api.qa.citygridmedia.com
     places: 
       endpoint: content/places/v2
-      hostname: api.citygridmedia.com
+      hostname: api.qa.citygridmedia.com
     reviews:
       endpoint: content/reviews/v2
-      hostname: api.citygridmedia.com
+      hostname: api.qa.citygridmedia.com
     response:
       endpoint: content/reviews/v2/response
     profile_internal: #internal use only

data/lib/citygrid.rb

@@ -37,12 +37,16 @@ class CityGrid
       defined?(@print_curls) ? @print_curls : false
     end
 
-    def use_vcr= v
-      @use_vcr = v
+    def custom_timeout= timeout #in seconds
+      @custom_timeout = timeout
     end
-    
-    def use_vcr?
-      defined?(VCR) && defined?(@use_vcr) && @use_vcr
+
+    def custom_timeout
+      @custom_timeout
+    end
+
+    def custom_timeout_set?
+      defined?(@custom_timeout)
     end
     
     def search opts = {}

data/lib/citygrid/api.rb

@@ -174,6 +174,7 @@ class CityGrid
         
         # prepare request
         req = HTTParty::Request.new http_method, path, req_options
+        req.options[:timeout] = CityGrid.custom_timeout if req.options && CityGrid.custom_timeout_set?
 
         # Sanitized request for logs
         safe_req_options = strip_unsafe_params(http_method, req_options)

data/lib/citygrid/api/advertising/campaign_promotions.rb

@@ -0,0 +1,9 @@
+class CityGrid
+  class API
+    class Advertising
+      class CampaignPromotions < Advertising
+        include CityGrid::API::Mutable
+      end
+    end
+  end
+end

data/lib/citygrid/api/mutable.rb

@@ -7,6 +7,9 @@ class CityGrid
         base.define_action :mutate, :post, "mutate",
           :auth_token => true,
           :format => false
+        base.define_action :mutate_post_only, :post, nil,
+          :auth_token => true,
+          :format => false
       end
     end
   end

data/spec/api_status_checks/content/listing_api_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "listing apis" do
+  
+  context "search" do
+  
+    it "should not raise an error" do
+      lambda do
+        CityGrid.search :what => "sushi", :where => "Seattle"
+      end.should_not raise_error
+    end
+  
+    it "should get a response" do
+      data = CityGrid.search :what => "sushi", :where => "Seattle"
+      data.should_not be_empty
+      data.first.should_not be_empty
+    end
+    
+  end
+  
+  context "details" do
+    # CityGrid::Details.new :public_id =>
+    
+    it "should not raise an error" do
+      lambda do
+        CityGrid::Details.new :public_id => "philip-marie-restaurant-new-york"
+      end.should_not raise_error
+    end
+  
+    it "should get a response" do
+      data = CityGrid::Details.new :public_id => "philip-marie-restaurant-new-york"
+      data.should_not be_empty
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), '..', 'test', "auth_token")
+require File.join(File.dirname(__FILE__), '..', 'test', "session_helper")
+require "pp"
+
+# don't do gem setup if we're in the dashboad environment
+unless defined? IN_DASHBOARD
+  require 'rubygems'
+  require 'bundler'
+  begin
+    Bundler.setup(:default, :development)
+  rescue Bundler::BundlerError => e
+    $stderr.puts e.message
+    $stderr.puts "Run `bundle install` to install missing gems"
+    exit e.status_code
+  end
+  require "riot"
+
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  $LOAD_PATH.unshift(File.dirname(__FILE__))
+  require "citygrid_api"
+  require "publisher_helper"
+
+  # load default config
+  CityGrid.load_config File.expand_path(File.join(File.dirname(__FILE__), '..', 'citygrid_api.yml.sample'))
+
+  # CityGrid.load_config File.expand_path(File.join(File.dirname(__FILE__), '..', 'citygrid_api.yml.sandbox'))
+
+  # Run code with rescue so that exceptions
+  # will be printed, but won't stop test suite
+  def run_with_rescue
+    begin
+      yield
+    # TODO: fix?
+    #rescue CityGrid::API::InvalidResponseFormat => ex
+    rescue StandardError => ex
+      x = {"description" => ex.message, "server_msg" => "blank"}
+      #x = {"description" => ex.description, "server_msg" => ex.server_msg}
+      puts "======= ERROR ======="
+      pp x
+      pp ex.backtrace
+      false
+    rescue => ex
+      pp ex
+      puts ex.backtrace.join("\n")
+      false # return false
+    end
+  end
+
+  # patch in VCR
+  require 'vcr'
+
+  VCR.config do |c|
+    c.cassette_library_dir = 'fixtures/vcr_cassettes'
+    c.stub_with :webmock
+    c.allow_http_connections_when_no_cassette = true
+  end
+
+  # contexts now use VCR, with a cassette named by the description
+  module Riot
+    class Context
+      alias_method :old_run, :run
+      def run reporter
+        # TODO: does it make any sense for API gem to use vcr?
+        #if option(:vcr) != nil && option(:vcr) == false
+         old_run reporter
+        # else
+        #  VCR.use_cassette self.detailed_description[0..70] do
+        #    old_run reporter
+        #  end
+        # end
+      end
+
+    end
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: citygrid_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors: 
 - Elpizo Choi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-22 00:00:00 Z
+date: 2012-12-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -18,7 +18,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 0.8.1
   type: :runtime
@@ -29,7 +29,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 1.5.3
   type: :runtime
@@ -100,6 +100,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id009
 description: Ruby wrapper for CityGrid APIs
 email: fu7iin@gmail.com
 executables: []
@@ -187,6 +198,7 @@ files:
 - lib/citygrid/api/advertising/budget.rb
 - lib/citygrid/api/advertising/call_detail.rb
 - lib/citygrid/api/advertising/campaign.rb
+- lib/citygrid/api/advertising/campaign_promotions.rb
 - lib/citygrid/api/advertising/category.rb
 - lib/citygrid/api/advertising/geolocation.rb
 - lib/citygrid/api/advertising/image.rb
@@ -216,6 +228,8 @@ files:
 - lib/request_ext.rb
 - lib/string_ext.rb
 - public/javascript/dashboard.js
+- spec/api_status_checks/content/listing_api_spec.rb
+- spec/spec_helper.rb
 - test/api/accounts/test_account.rb
 - test/api/accounts/test_method_of_payment.rb
 - test/api/accounts/test_temp_impersonation.rb