citygrid_api 0.0.5 → 0.0.5.1

data/Gemfile

@@ -1,15 +1,17 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem "httparty", "~> 0.7.8"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem "httparty", "~> 0.8.1"
+gem "json", "1.5.3"
+gem "riot", "~> 0.12.4"
+gem "awesome_print", "~> 0.4.0", :require => "ap"
+gem "haml"
+
 group :development do
-  gem "awesome_print", "~> 0.4.0", :require => "ap"
-  gem "riot", "~> 0.12.4"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.2"
   gem "rcov", ">= 0"
 end
+
+group :dashboard do
+  gem "sinatra"
+end

data/Gemfile.lock

@@ -2,19 +2,31 @@ GEM
   remote: http://rubygems.org/
   specs:
     awesome_print (0.4.0)
-    crack (0.1.8)
     git (1.2.5)
-    httparty (0.7.8)
-      crack (= 0.1.8)
-    jeweler (1.6.2)
+    haml (3.1.4)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.9.2)
-    rcov (0.9.9)
-    riot (0.12.4)
+    json (1.5.3)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    rack (1.3.5)
+    rack-protection (1.1.4)
+      rack
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    riot (0.12.5)
       rr
-    rr (1.0.2)
+    rr (1.0.4)
+    sinatra (1.3.1)
+      rack (~> 1.3, >= 1.3.4)
+      rack-protection (~> 1.1, >= 1.1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
 
 PLATFORMS
   ruby
@@ -22,7 +34,10 @@ PLATFORMS
 DEPENDENCIES
   awesome_print (~> 0.4.0)
   bundler (~> 1.0.0)
-  httparty (~> 0.7.8)
+  haml
+  httparty (~> 0.8.1)
   jeweler (~> 1.6.2)
+  json (= 1.5.3)
   rcov
   riot (~> 0.12.4)
+  sinatra

data/README

@@ -0,0 +1,21 @@
+= citygrid
+
+Don't use this.  NOT PRODUCTION READY
+
+Description goes here.
+
+== Contributing to citygrid
+
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 Elpizo Choi. See LICENSE.txt for
+further details.
+

data/citygrid_api.gemspec

@@ -4,27 +4,33 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{citygrid_api}
-  s.version = "0.0.5"
+  s.name = "citygrid_api"
+  s.version = "0.0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elpizo Choi"]
-  s.date = %q{2011-07-18}
-  s.description = %q{Ruby wrapper for CityGrid APIs}
-  s.email = %q{fu7iin@gmail.com}
+  s.date = "2011-12-17"
+  s.description = "Ruby wrapper for CityGrid APIs"
+  s.email = "fu7iin@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
+    "README",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    ".sass-cache/7a5a675d951455410512a59af5ab2d160bd1735c/test.scssc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
+    "README",
     "README.rdoc",
     "Rakefile",
     "VERSION",
     "citygrid_api.gemspec",
+    "citygrid_api.yml.sample",
+    "config.ru",
+    "dashboard.rb",
     "lib/citygrid.rb",
     "lib/citygrid/abstraction.rb",
     "lib/citygrid/abstraction/collection.rb",
@@ -33,7 +39,25 @@ Gem::Specification.new do |s|
     "lib/citygrid/abstraction/super_array.rb",
     "lib/citygrid/abstraction/super_hash.rb",
     "lib/citygrid/api.rb",
-    "lib/citygrid/api/base.rb",
+    "lib/citygrid/api/ad_center.rb",
+    "lib/citygrid/api/ad_center/account.rb",
+    "lib/citygrid/api/ad_center/account_manager.rb",
+    "lib/citygrid/api/ad_center/ad_group.rb",
+    "lib/citygrid/api/ad_center/ad_group_ad.rb",
+    "lib/citygrid/api/ad_center/ad_group_criterion.rb",
+    "lib/citygrid/api/ad_center/ad_group_geo.rb",
+    "lib/citygrid/api/ad_center/authentication.rb",
+    "lib/citygrid/api/ad_center/billing.rb",
+    "lib/citygrid/api/ad_center/budget.rb",
+    "lib/citygrid/api/ad_center/call_detail.rb",
+    "lib/citygrid/api/ad_center/campaign.rb",
+    "lib/citygrid/api/ad_center/category.rb",
+    "lib/citygrid/api/ad_center/geolocation.rb",
+    "lib/citygrid/api/ad_center/image.rb",
+    "lib/citygrid/api/ad_center/method_of_payment.rb",
+    "lib/citygrid/api/ad_center/performance.rb",
+    "lib/citygrid/api/ad_center/places.rb",
+    "lib/citygrid/api/ad_center/user.rb",
     "lib/citygrid/api/content.rb",
     "lib/citygrid/api/content/offers.rb",
     "lib/citygrid/api/content/places.rb",
@@ -47,42 +71,78 @@ Gem::Specification.new do |s|
     "lib/citygrid/reviews.rb",
     "lib/citygrid/search.rb",
     "lib/citygrid_api.rb",
+    "lib/dashboard/sinatra_partial.rb",
+    "lib/dashboard/stored_reporter.rb",
+    "lib/dashboard/test_result.rb",
+    "lib/request_ext.rb",
+    "public/javascript/dashboard.js",
+    "test/api/ad_center/test_account.rb",
+    "test/api/ad_center/test_ad_group.rb",
+    "test/api/ad_center/test_ad_group_ad.rb",
+    "test/api/ad_center/test_ad_group_criterion.rb",
+    "test/api/ad_center/test_ad_group_geo.rb",
+    "test/api/ad_center/test_authentication.rb",
+    "test/api/ad_center/test_billing.rb",
+    "test/api/ad_center/test_budget.rb",
+    "test/api/ad_center/test_call_detail.rb",
+    "test/api/ad_center/test_campaign.rb",
+    "test/api/ad_center/test_category.rb",
+    "test/api/ad_center/test_geolocation.rb",
+    "test/api/ad_center/test_image.rb",
+    "test/api/ad_center/test_method_of_payment.rb",
+    "test/api/ad_center/test_places.rb",
+    "test/api/ad_center/test_reports.rb",
+    "test/api/content/test_offers.rb",
+    "test/api/content/test_places.rb",
     "test/helper.rb",
     "test/publisher_helper.rb.sample",
-    "test/test_citygrid.rb",
+    "test/test_config.rb",
     "test/test_details.rb",
+    "test/test_img.jpg",
+    "test/test_img_big.png",
     "test/test_listing.rb",
     "test/test_search.rb",
     "test/test_super_array.rb",
-    "test/test_super_hash.rb"
+    "test/test_super_hash.rb",
+    "views/_context_result.haml",
+    "views/_request.haml",
+    "views/_test_result.haml",
+    "views/stylesheets/test.scss",
+    "views/test.haml"
   ]
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{Ruby wrapper for CityGrid APIs}
+  s.rubygems_version = "1.8.12"
+  s.summary = "Ruby wrapper for CityGrid APIs"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, ["~> 0.7.8"])
-      s.add_development_dependency(%q<awesome_print>, ["~> 0.4.0"])
-      s.add_development_dependency(%q<riot>, ["~> 0.12.4"])
+      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_runtime_dependency(%q<awesome_print>, ["~> 0.4.0"])
+      s.add_runtime_dependency(%q<haml>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<httparty>, ["~> 0.7.8"])
-      s.add_dependency(%q<awesome_print>, ["~> 0.4.0"])
+      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<awesome_print>, ["~> 0.4.0"])
+      s.add_dependency(%q<haml>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<httparty>, ["~> 0.7.8"])
-    s.add_dependency(%q<awesome_print>, ["~> 0.4.0"])
+    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<awesome_print>, ["~> 0.4.0"])
+    s.add_dependency(%q<haml>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/citygrid_api.yml.sample

@@ -0,0 +1,33 @@
+defaults:
+  hostname: api.qa.citygrid.com
+  ssl_hostname: api-qassl.citygrid.com
+
+# endpoint_name: endpoint
+# OR 
+# endpoint_name:
+#   ssl: true/false
+#   endpoint: endpoint
+
+endpoints:
+  account:
+    ssl: true
+    endpoint: accounts/account/v2
+  ad_group: advertising/adgroup/v2
+  ad_group_ad: advertising/adgroupad/v2
+  ad_group_criterion: advertising/adgroupcriterion/v2
+  ad_group_geo: advertising/adgroupgeo/v2  
+  authentication:
+    ssl: true
+    endpoint: accounts/user/v2    
+  budget: advertising/budget/v2/recommend
+  campaign: advertising/campaign/v2
+  category: content/category/v2
+  geo_location: content/places/v2/geocode
+  image: advertising/image/v2
+  method_of_payment:
+    ssl: true
+    endpoint: accounts/mop/v2
+  places: content/places/v2
+  performance: advertising/performance/v2/campaign
+  user: accounts/user/v2
+  call_detail: advertising/calldetail/v2

data/config.ru

@@ -0,0 +1,2 @@
+require './dashboard'
+run Sinatra::Application

data/dashboard.rb

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'sinatra'
+require "awesome_print"
+require "riot"
+require "haml"
+require 'stringio'
+
+IN_DASHBOARD = true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib', "dashboard"))  
+require "stored_reporter"
+require "sinatra_partial"
+require "test_result"
+
+helpers Sinatra::Partials
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))  
+require "citygrid_api"
+CityGrid.publisher = "test"
+CityGrid.load_config File.join(File.dirname(__FILE__), 'citygrid_api.yml.sample'), "qa"
+
+def run_with_rescue
+  # don't do anything here, we'll catch
+  yield
+end
+
+module Riot
+  class Context
+    def run(reporter)
+      reporter.describe_context(self)
+      local_run(reporter, situation_class.new)
+      run_sub_contexts(reporter)
+      reporter
+    end
+  end
+end
+
+# hack to trap all HTTParty::Requests so we can inspect them
+class RequestTrap
+  def self.trap
+    @@trap ||= []
+  end
+end
+
+module HTTParty
+  class Request
+    alias_method :old_perform, :perform
+    
+    def perform
+      RequestTrap.trap << self
+      old_perform
+    end
+  end
+end
+
+# render stylesheets
+get '/stylesheets/:name.css' do
+ content_type 'text/css', :charset => 'utf-8'
+ scss :"stylesheets/#{params[:name]}"
+end
+
+get '/' do
+  # we want to run tests ourselves
+  Riot.alone!
+
+  # test_paths = Dir.glob "test/**/test_*.rb"  
+  test_paths = Dir.glob("test/api/ad_center/test_*.rb").sort
+  # test_paths = ["test/api/ad_center/test_account.rb"]
+  
+  @results = []
+  test_paths.each do |path|
+    eval(IO.read(path), binding, path)
+    # root_contexts << [path, Riot.root_contexts.clone]
+    
+    result = TestResult.new path.gsub(/^test\//, "").gsub(/\.rb$/, "").split("/").map{|x| x.gsub("_", " ")}.join(" > ")
+    Riot.root_contexts.each do |context|
+      out = StringIO.new
+      reporter = StoredReporter.new out
+      begin
+        # $stdout = out
+        context.run reporter
+      rescue CityGrid::API::InvalidResponseFormat => ex
+        puts "CAUGHT AN ERROR!"
+        x = {"description" => ex.description, "server_msg" => ex.server_msg}
+        reporter.fail ex.description, ex.server_msg, "", ""
+      rescue => ex
+        puts "CAUGHT AN ERROR!"
+        reporter.fail ex.to_s, "", "", ""
+      ensure 
+        # $stdout = STDOUT  
+      end
+
+      reporter.context_finished
+      result.results += reporter.context_results
+    end
+    
+    @results << result
+    
+    Riot.root_contexts.clear
+  end
+  
+  haml :test
+end
+
+get '/evented' do
+  stream(:keep_open) do |out|
+    EventMachine::PeriodicTimer.new(1) { out << "#{Time.now}\n" }
+  end
+end
+

data/lib/citygrid/abstraction/collection.rb

@@ -8,7 +8,7 @@ class CityGrid
       end
 
       def update array
-        replace array
+        replace array if array
       end
     end
   end

data/lib/citygrid/abstraction/super_hash.rb

@@ -15,6 +15,8 @@ class CityGrid
         # create new SuperHash if value is hash
         if val.is_a? Hash
           SuperHash.new val
+        elsif val.is_a? Array
+          SuperArray.new val
         elsif keys.include?(sym) || keys.include?(sym.to_s)
           val
         else

data/lib/citygrid/api/ad_center/account.rb

@@ -0,0 +1,26 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Account < AdCenter
+        # Adds new customer account to existing user
+        # http://docs.prod.cs/display/citygridv2/Internal+-+Account#Internal-Account-AddNewCustomerAccounttoExistingUser
+        def self.import_to_cg options = {}
+          token = extract_auth_token options
+          request_and_handle :post,
+            "#{base_uri}/accounts/account/v2/customer/mutate",
+            :body    => options.to_json,
+            :headers => merge_headers("authToken" => token)
+        end
+        
+        #http://docs-dev.prod.cs/display/citygridv2/Internal+-+Account+Type
+        def self.account_type options = {}
+          token = extract_auth_token options
+          request_and_handle :get,
+            "#{endpoint}/get/type",
+            :query => options,
+            :headers => merge_headers("authToken" => token)
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/account_manager.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class AccountManager <  AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/ad_group.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class AdGroup < AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/ad_group_ad.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class AdGroupAd < AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/ad_group_criterion.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class AdGroupCriterion < AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/ad_group_geo.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class AdGroupGeo < AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/authentication.rb

@@ -0,0 +1,20 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Authentication < AdCenter
+        def self.login options = {}
+          request_and_handle :post,
+            "#{endpoint}/login",
+            :query => options
+        end
+        
+        def self.validate options = {}
+          request_and_handle :get,
+            "#{endpoint}/validate",
+            :query => options,
+            :headers => merge_headers
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/billing.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Billing <  AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/budget.rb

@@ -0,0 +1,9 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Budget < AdCenter
+        endpoint "/adcenter/budget/v2/recommendation"
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/call_detail.rb

@@ -0,0 +1,25 @@
+class CityGrid
+  class API
+    class AdCenter
+      class CallDetail < AdCenter
+        class << self
+          def get by, options = {}
+            token = extract_auth_token options
+            request_and_handle :post,
+              "#{endpoint}/#{by}",
+              :body    => options.to_json,
+              :headers => merge_headers("authToken" => token)
+          end
+          
+          def note options = {}
+            token = extract_auth_token options
+            request_and_handle :post,
+              "#{endpoint}/note",
+              :body    => options.to_json,
+              :headers => merge_headers("authToken" => token)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/campaign.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Campaign < AdCenter
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/category.rb

@@ -0,0 +1,9 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Category < AdCenter
+        endpoint "/adcenter/categories/v2"
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/geolocation.rb

@@ -0,0 +1,9 @@
+class CityGrid
+  class API
+    class AdCenter
+      class GeoLocation < AdCenter
+        endpoint "/adcenter/categories/v2"
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/image.rb

@@ -0,0 +1,30 @@
+require 'base64'
+
+class CityGrid
+  class API
+    class AdCenter
+      class Image < AdCenter
+        def self.upload user_id, name, type, image_path, options = {}
+          token = extract_auth_token options
+          image_data = Base64.encode64(File.open(image_path).read.to_s).gsub(/\n/, "")
+          format = options[:format] || image_path.split(".").last
+          request_and_handle :post,
+            "#{base_uri}/#{endpoint}/upload",
+            :body => {"mutateOperationListResource" => [
+              {
+                "operand" => {
+                	"image_type" => type,
+                	"image_name" => name,
+                	"image_format" => format,
+                	"image" => image_data
+                  },
+                "operator" => "ADD",
+                "userId" => user_id
+              }
+            ]}.to_json,
+            :headers => merge_headers("authToken" => token)
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/method_of_payment.rb

@@ -0,0 +1,10 @@
+class CityGrid
+  class API
+    class AdCenter
+      class MethodOfPayment < AdCenter
+        server :ssl
+        endpoint "/adcenter/account/v2/mop"
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/performance.rb

@@ -0,0 +1,17 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Performance < AdCenter
+        class << self
+          def summary type, options = {}
+            token = extract_auth_token options
+            request_and_handle :post,
+              "#{endpoint}/#{type}",
+              :body    => options.to_json,
+              :headers => merge_headers("authToken" => token)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/api/ad_center/places.rb

@@ -0,0 +1,8 @@
+class CityGrid
+  class API
+    class AdCenter
+      class Places < AdCenter
+      end
+    end
+  end
+end