citygrid_api 0.0.6 → 0.0.7

data/README.rdoc

@@ -1,21 +1,50 @@
 = citygrid
 
-Don't use this.  NOT PRODUCTION READY
+Not stable yet. Use at your own risk!
 
-Description goes here.
+== Getting Started
 
-== Contributing to citygrid
+=== Installation
 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+This gem is still under very active development. As such, you can obtain the latest by directly installing from github:
 
-== Copyright
+   gem "citygrid_api", :git => "git://github.com/CityGrid/citygrid_api.git"
 
-Copyright (c) 2011 Elpizo Choi. See LICENSE.txt for
-further details.
+You can get a relatively stable build from rubygems.org. Specifying a version number is highly recommended as there will be breaking changes until we stabilize. 
 
+   gem "citygrid_api", "0.0.6" 
+
+=== Configuration
+
+Add a file called citygrid_api.rb under config/initializers. 
+
+Configure the gem to use your publisher code with:
+
+   CityGrid.publisher = 'your_publisher_code'
+   
+If you don't have a publisher code, you can obtain one at http://developer.citygridmedia.com
+
+Move citygrid_api.yml.sample into your project. This file configures the API endpoints. Load the configuration with:
+
+   CityGrid.load_config 'path/to/config/yml'
+
+== Sessions
+
+Most methods require an AuthToken. This is obtained by either using the CityGrid::Session class (preferred) or CityGrid::API::Accounts::Account.login, which would require managing your own AuthToken.
+
+An authenticated session can be obtained with
+
+   session = CityGrid.session 'username', 'password'
+   
+Once authenticated, the session will automatically pass along the AuthToken to API methods that require it when you use the call_api method
+
+  session.call_api CityGrid::API::Advertising::Category,
+    :search,
+    :keywords => "pizza"
+    
+This corresponds to
+
+  auth_token = 'my_auth_token' # obtained by calling CityGrid::API::Accounts::Account.login
+  CityGrid::API::Advertising::Category.search :token => auth_token, :keywords => "pizza"
+
+In the future, AuthTokens may be invalidated and there may be other methods to log in. Session and call_api will handle that for you.

data/Rakefile

@@ -19,8 +19,8 @@ Jeweler::Tasks.new do |gem|
   gem.license = "MIT"
   gem.summary = %Q{Ruby wrapper for CityGrid APIs}
   gem.description = %Q{Ruby wrapper for CityGrid APIs}
-  gem.email = "fu7iin@gmail.com"
-  gem.authors = ["Elpizo Choi"]
+  gem.email = "Joseph.Chen@citygridmedia.com"
+  gem.authors = ["Elpizo Choi", "Joseph Chen"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/citygrid_api.gemspec

@@ -5,16 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = "citygrid_api"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Elpizo Choi"]
-  s.date = "2011-12-30"
+  s.authors = ["Elpizo Choi", "Joseph Chen"]
+  s.date = "2012-02-27"
   s.description = "Ruby wrapper for CityGrid APIs"
-  s.email = "fu7iin@gmail.com"
+  s.email = "Joseph.Chen@citygridmedia.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README",
     "README.rdoc"
   ]
   s.files = [
@@ -24,26 +23,23 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README",
     "README.rdoc",
     "Rakefile",
     "VERSION",
     "citygrid_api.gemspec",
-    "citygrid_api.yml.backup",
     "citygrid_api.yml.sample",
+    "citygrid_api.yml.sandbox",
     "config.ru",
     "dashboard.rb",
     "fixtures/vcr_cassettes/AdGroupCriterion_mutate.yml",
     "fixtures/vcr_cassettes/AdGroupCriterion_search.yml",
     "fixtures/vcr_cassettes/Adding_a_place.yml",
-    "fixtures/vcr_cassettes/Call_Detail_by_campaign.yml",
     "fixtures/vcr_cassettes/Geo.yml",
+    "fixtures/vcr_cassettes/Getting_an_offer.yml",
     "fixtures/vcr_cassettes/Getting_an_offer_by_listing_ID.yml",
     "fixtures/vcr_cassettes/Import_a_cg_account.yml",
     "fixtures/vcr_cassettes/Initiating_a_Details.yml",
     "fixtures/vcr_cassettes/Initiating_new_MultiDetails.yml",
-    "fixtures/vcr_cassettes/Method_of_Payment_mutate.yml",
-    "fixtures/vcr_cassettes/Method_of_Payment_search.yml",
     "fixtures/vcr_cassettes/Mutating_AdGroup_Ads.yml",
     "fixtures/vcr_cassettes/Report_summary_daily.yml",
     "fixtures/vcr_cassettes/Report_summary_user_actions.yml",
@@ -55,14 +51,23 @@ Gem::Specification.new do |s|
     "fixtures/vcr_cassettes/Searching_categories_by_listing_id.yml",
     "fixtures/vcr_cassettes/Searching_categories_by_query.yml",
     "fixtures/vcr_cassettes/Upload_an_image_Add_a_preview.yml",
+    "fixtures/vcr_cassettes/create_a_mop.yml",
+    "fixtures/vcr_cassettes/create_an_offer.yml",
     "fixtures/vcr_cassettes/create_campaign.yml",
+    "fixtures/vcr_cassettes/create_campaign_then_create_ad_group_belonging_to_campaign.yml",
+    "fixtures/vcr_cassettes/create_campaign_then_create_ad_group_belonging_to_campaign_then_search_.yml",
+    "fixtures/vcr_cassettes/getting_reviews_by_listing_id.yml",
     "fixtures/vcr_cassettes/log_in_a_session.yml",
     "fixtures/vcr_cassettes/log_in_a_session_mutate_places.yml",
     "fixtures/vcr_cassettes/query_account_type_by_id.yml",
     "fixtures/vcr_cassettes/search_for_an_account_by_id.yml",
     "fixtures/vcr_cassettes/search_for_an_account_by_name.yml",
+    "fixtures/vcr_cassettes/search_for_call_detail_by_campaign.yml",
+    "fixtures/vcr_cassettes/search_for_mop_by_account_id.yml",
     "fixtures/vcr_cassettes/searching_for_a_CityGrid_listing.yml",
     "fixtures/vcr_cassettes/searching_for_a_special_CityGrid_listing.yml",
+    "fixtures/vcr_cassettes/user_log_in_with_raw_API.yml",
+    "fixtures/vcr_cassettes/user_log_in_with_session.yml",
     "lib/citygrid.rb",
     "lib/citygrid/abstraction.rb",
     "lib/citygrid/abstraction/collection.rb",
@@ -89,13 +94,15 @@ Gem::Specification.new do |s|
     "lib/citygrid/api/advertising/category.rb",
     "lib/citygrid/api/advertising/geolocation.rb",
     "lib/citygrid/api/advertising/image.rb",
+    "lib/citygrid/api/advertising/offers.rb",
     "lib/citygrid/api/advertising/performance.rb",
     "lib/citygrid/api/advertising/places.rb",
     "lib/citygrid/api/content.rb",
     "lib/citygrid/api/content/offers.rb",
     "lib/citygrid/api/content/places.rb",
+    "lib/citygrid/api/content/response.rb",
     "lib/citygrid/api/content/reviews.rb",
-    "lib/citygrid/api/mutatable.rb",
+    "lib/citygrid/api/mutable.rb",
     "lib/citygrid/api/response.rb",
     "lib/citygrid/api/searchable.rb",
     "lib/citygrid/details.rb",
@@ -113,6 +120,7 @@ Gem::Specification.new do |s|
     "public/javascript/dashboard.js",
     "test/api/accounts/test_account.rb",
     "test/api/accounts/test_method_of_payment.rb",
+    "test/api/accounts/test_user.rb",
     "test/api/advertising/test_account_manager.rb",
     "test/api/advertising/test_ad_group.rb",
     "test/api/advertising/test_ad_group_ad.rb",
@@ -125,10 +133,13 @@ Gem::Specification.new do |s|
     "test/api/advertising/test_create_campaign_and_ad_group.rb",
     "test/api/advertising/test_geolocation.rb",
     "test/api/advertising/test_image.rb",
+    "test/api/advertising/test_offers.rb",
     "test/api/advertising/test_performance.rb",
     "test/api/advertising/test_places.rb",
     "test/api/content/test_details.rb",
     "test/api/content/test_offers.rb",
+    "test/api/content/test_response.rb",
+    "test/api/content/test_reviews.rb",
     "test/api/content/test_search.rb",
     "test/auth_token.rb",
     "test/helper.rb",
@@ -149,7 +160,7 @@ Gem::Specification.new do |s|
   ]
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.12"
+  s.rubygems_version = "1.8.10"
   s.summary = "Ruby wrapper for CityGrid APIs"
 
   if s.respond_to? :specification_version then

data/citygrid_api.yml.sample

@@ -29,11 +29,14 @@ api:
     ad_group_geo: advertising/adgroupgeo/v2  
     budget: advertising/budget/v2/recommend
     billing: advertising/billing/v2
-    call_detail: advertising/calldetail/v2
+    call_detail:
+      endpoint: report/calldetail/v2
+      hostname: lax1qatxpi4.test.cs:8080
     campaign: advertising/campaign/v2
     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:
@@ -42,4 +45,9 @@ api:
       hostname: api.citygridmedia.com
     places: 
       endpoint: content/places/v2
-      hostname: api.citygridmedia.com
+      hostname: api.citygridmedia.com
+    reviews:
+      endpoint: content/reviews/v2
+      hostname: api.citygridmedia.com
+    response:
+      endpoint: content/reviews/v2/response

data/citygrid_api.yml.sandbox

@@ -0,0 +1,46 @@
+defaults:
+  hostname: sandbox-api.citygrid.com
+  ssl_hostname: sandbox-api.citygrid.com
+
+# endpoint_name: endpoint
+# OR 
+# endpoint_name:
+#   ssl: true/false
+#   endpoint: endpoint
+
+api:
+  accounts:
+    account:
+      ssl: true
+      endpoint: accounts/account/v2      
+    method_of_payment:
+      ssl: true
+      endpoint: accounts/mop/v2
+    user: 
+      ssl: true
+      endpoint: accounts/user/v2
+  advertising:
+    account_manager:
+      ssl: true
+      endpoint: advertising/campaign/v2/accountmanager
+    ad_group: advertising/adgroup/v2
+    ad_group_ad: advertising/adgroupad/v2
+    ad_group_criterion: advertising/adgroupcriterion/v2
+    ad_group_geo: advertising/adgroupgeo/v2  
+    budget: advertising/budget/v2/recommend
+    billing: advertising/billing/v2
+    call_detail: advertising/calldetail/v2
+    campaign: advertising/campaign/v2
+    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
+    places: 
+      endpoint: content/places/v2
+      hostname: api.citygridmedia.com

data/dashboard.rb

@@ -64,7 +64,7 @@ get '/' do
   Riot.alone!
 
   # test_paths = Dir.glob "test/**/test_*.rb"  
-  test_paths = Dir.glob("test/api/ad_center/test_*.rb").sort
+  test_paths = Dir.glob("test/**/test_*.rb").sort
   # test_paths = ["test/api/ad_center/test_account.rb"]
   
   @results = []

data/fixtures/vcr_cassettes/AdGroupCriterion_mutate.yml

@@ -2,7 +2,7 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :post
-    uri: http://api.qa.citygrid.com:80/advertising/adgroupcriterion/v2/mutate
+    uri: http://sandbox-api.citygrid.com:80/advertising/adgroupcriterion/v2/mutate
     body: ! '{"mutateOperationListResource":[{"operator":"ADD","operand":{"adGroupId":"2","adGroupAdId":"1","adGroupCriterionId":"1722","type":"2"}},{"operator":"REMOVE","operand":{"adGroupId":"2","adGroupAdId":"1","adGroupCriterionId":"1722","type":"2"}}]}'
     headers:
       accept:
@@ -10,14 +10,14 @@
       content-type:
       - Application/JSON
       authtoken:
-      - 563da3d1cfa3a8e75f6a09e89f542d67
+      - 20f1918ababef692f0b7e71940acbe4b
   response: !ruby/struct:VCR::Response
     status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
     headers:
       date:
-      - Fri, 30 Dec 2011 01:06:02 GMT
+      - Sat, 31 Dec 2011 01:12:36 GMT
       server:
       - Apache-Coyote/1.1
       content-type:

data/fixtures/vcr_cassettes/AdGroupCriterion_search.yml

@@ -2,7 +2,7 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: http://api.qa.citygrid.com:80/advertising/adgroupcriterion/v2/get?adGroupId=6
+    uri: http://sandbox-api.citygrid.com:80/advertising/adgroupcriterion/v2/get?adGroupId=6
     body: !!null 
     headers:
       accept:
@@ -10,14 +10,14 @@
       content-type:
       - Application/JSON
       authtoken:
-      - 563da3d1cfa3a8e75f6a09e89f542d67
+      - 20f1918ababef692f0b7e71940acbe4b
   response: !ruby/struct:VCR::Response
     status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
     headers:
       date:
-      - Fri, 30 Dec 2011 01:06:02 GMT
+      - Sat, 31 Dec 2011 01:12:34 GMT
       server:
       - Apache-Coyote/1.1
       content-type:

data/fixtures/vcr_cassettes/Adding_a_place.yml

@@ -2,7 +2,7 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :post
-    uri: http://api.qa.citygrid.com:80/content/places/v2/mutate
+    uri: http://sandbox-api.citygrid.com:80/content/places/v2/mutate
     body: ! '{"mutateOperationListResource":[{"operator":"ADD","operand":{"name":"Pi
       on sunset in LAAAAAAAAAAAAAA","address_1":"Jackson 2102","address_2":"","city":"Los
       Angeles","state":"California","postal_code":90025,"phone_number":3103333333,"website_url":"pi.com","primary_tag_id":3623,"bullet1":"Knoll
@@ -13,14 +13,14 @@
       content-type:
       - Application/JSON
       authtoken:
-      - 92e47a6fae6c86044c1b697d85d7add8
+      - 2f45061f07f7e61a9f3953d7bfbd904b
   response: !ruby/struct:VCR::Response
     status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
     headers:
       date:
-      - Fri, 30 Dec 2011 01:06:15 GMT
+      - Sat, 31 Dec 2011 01:13:18 GMT
       server:
       - Apache-Coyote/1.1
       content-type:
@@ -29,5 +29,5 @@
       - Accept-Encoding
       transfer-encoding:
       - chunked
-    body: ! '{"resources":[{"response":{"message":"OK","code":200},"listingId":904202040}]}'
+    body: ! '{"resources":[{"response":{"message":"OK","code":200},"listingId":904202230}]}'
     http_version: '1.1'

data/fixtures/vcr_cassettes/Geo.yml

@@ -2,7 +2,7 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: http://api.qa.citygrid.com:80/content/places/v2/geocode/get?city=seattle&state=wa&streetAddress=720%203rd%20ave&zipCode=98007
+    uri: http://sandbox-api.citygrid.com:80/content/places/v2/geocode/get?city=seattle&state=wa&streetAddress=720%203rd%20ave&zipCode=98007
     body: !!null 
     headers:
       accept:
@@ -13,20 +13,37 @@
       - ''
   response: !ruby/struct:VCR::Response
     status: !ruby/struct:VCR::ResponseStatus
-      code: 200
-      message: OK
+      code: 403
+      message: Forbidden
     headers:
       date:
-      - Fri, 30 Dec 2011 01:06:11 GMT
+      - Sat, 31 Dec 2011 01:13:14 GMT
       server:
-      - Apache-Coyote/1.1
+      - Apache/2.2.4 (Unix) mod_perl/2.0.5 Perl/v5.8.5
+      content-length:
+      - '345'
       content-type:
-      - application/json
-      vary:
-      - Accept-Encoding
-      transfer-encoding:
-      - chunked
-    body: ! '{"totalNumEntries":1,"geocodeResponse":[{"address":{"state":"WA","city":"Seattle","streetAddress":"720
-      3rd Ave","zipCode":"98104-1868"},"geoAccuracy":"ADDRESS","postalConfidence":"APPROXIMATE","streetConfidence":"EXACT","lat":47.603618,"lon":-122.332203}],"message":"OK","searchAddress":"720
-      3rd ave, seattle, wa 98007"}'
+      - text/html; charset=iso-8859-1
+    body: ! '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+
+      <html><head>
+
+      <title>403 Forbidden</title>
+
+      </head><body>
+
+      <h1>Forbidden</h1>
+
+      <p>You don''t have permission to access /content/places/v2/geocode/get
+
+      on this server.</p>
+
+      <hr>
+
+      <address>Apache/2.2.4 (Unix) mod_perl/2.0.5 Perl/v5.8.5 Server at sandbox-api.citygrid.com
+      Port 80</address>
+
+      </body></html>
+
+'
     http_version: '1.1'