citygrid_api 0.0.9 → 0.0.10

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/citygrid_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "citygrid_api"
-  s.version = "0.0.9"
+  s.version = "0.0.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elpizo Choi", "Joseph Chen"]
-  s.date = "2012-03-01"
+  s.date = "2012-03-08"
   s.description = "Ruby wrapper for CityGrid APIs"
   s.email = "Joseph.Chen@citygridmedia.com"
   s.extra_rdoc_files = [
@@ -80,6 +80,7 @@ Gem::Specification.new do |s|
     "lib/citygrid/api/accounts/account.rb",
     "lib/citygrid/api/accounts/authentication.rb",
     "lib/citygrid/api/accounts/method_of_payment.rb",
+    "lib/citygrid/api/accounts/temp_impersonation.rb",
     "lib/citygrid/api/accounts/user.rb",
     "lib/citygrid/api/advertising.rb",
     "lib/citygrid/api/advertising/account_manager.rb",
@@ -121,6 +122,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_temp_impersonation.rb",
     "test/api/accounts/test_user.rb",
     "test/api/advertising/test_account_manager.rb",
     "test/api/advertising/test_ad_group.rb",

data/citygrid_api.yml.sample

@@ -12,13 +12,16 @@ api:
   accounts:
     account:
       ssl: true
-      endpoint: accounts/account/v2      
+      endpoint: accounts/account/v2     
     method_of_payment:
       ssl: true
       endpoint: accounts/mop/v2
     user: 
       ssl: true
       endpoint: accounts/user/v2
+    temp_impersonation:
+      endpoint: accounts/user/v2
+      hostname: qa-prdmirror.citygrid.com 
   advertising:
     account_manager:
       ssl: true

data/lib/citygrid/api/accounts/temp_impersonation.rb

@@ -0,0 +1,9 @@
+class CityGrid
+  class API
+    class Accounts
+      class TempImpersonation < Accounts
+      	define_action :impersonate, :get, "impersonate", :auth_token => true, :format => false
+      end
+    end
+  end
+end

data/lib/citygrid/api.rb

@@ -85,24 +85,50 @@ class CityGrid
           "options" => Net::HTTP::Options
         }
 
-      def strip_unsafe_params options
-        puts "OPTIONS: #{options}"
+      def strip_unsafe_params method, options
+        safe_options = options.dup
+        to_merge = {}
         unsafe_params = { 
-                          :password => "[FILTERED]", :securityCode => "[FILTERED]",
-                          :cardNumber => "[FILTERED]", :expirationMonth => "[FILTERED]",
-                          :expirationYear => "[FILTERED]"
+                          :password => "FILTERED", "securityCode" => "FILTERED",
+                          "cardNumber" => "FILTERED", "expirationMonth" => "FILTERED",
+                          "expirationYear" => "FILTERED"
                         }
-        if !options[:query].nil?
-          to_merge[:query] = options[:query].merge(unsafe_params.select { |k| options.keys.include? k })
-          return options.merge(to_merge)
+        # If the parameters are contained in the :body node of the options hash
+        if options[:body] && !options[:body].nil?
+          # Convert the inner JSON before doing any work
+          safe_options[:body] = JSON.parse(safe_options[:body])
+
+          # This handles the mop query format
+          if safe_options[:body]["mutateOperationListResource"] && 
+             safe_options[:body]["mutateOperationListResource"][0] &&
+             safe_options[:body]["mutateOperationListResource"][0]["operand"]
+            # All the sensitive fields are located in this path
+            target_hash = safe_options[:body]["mutateOperationListResource"][0]["operand"]
+            # Strip any elements from the unsafe params hash that aren't in options and merge
+            to_merge = target_hash.merge(unsafe_params.select { |k| target_hash.keys.include?(k) })
+            # Merge the clean operand hash back into the body
+            safe_options[:body]["mutateOperationListResource"][0]["operand"].merge!(to_merge)
+            # Convert the body key back to json before returning
+            safe_options[:body] = safe_options[:body].to_json
+            return safe_options
+          # Any other format with :body node 
+          else
+            to_merge = safe_options[:body].merge(unsafe_params.select { |k| safe_options[:body].keys.include? k })
+            return safe_options.merge({ :body => to_merge })
+          end
+        # If the parameters are contained in the :query node of the options hash
+        elsif options[:query] && !options[:query].nil?
+          to_merge = safe_options[:query].merge(unsafe_params.select { |k| safe_options[:query].keys.include? k })
+          return safe_options.merge({ :query => to_merge })
+        else
+          return options
         end
       end
 
-      # 
       def parse_multiple_responses response
         parsing = response.values.select{ |x| x.is_a? Array }.first
         if parsing.nil? || parsing == []
-          ap "Response was too hard to parse... letting it through..."
+          #ap "Response was too hard to parse... letting it through..."
           return parsing
         elsif parsing != nil && parsing != []
           if parsing[0]["response"]
@@ -110,7 +136,7 @@ class CityGrid
             return parsing
           else
             # this accomodates geocode response which does not contain a response node
-            ap "Response was too hard to parse... letting it through..."
+            #ap "Response was too hard to parse... letting it through..."
             return nil
           end
         else
@@ -133,16 +159,12 @@ class CityGrid
         raise ConfigurationError.new "No endpoint defined" if !path || path.empty?
         raise ConfigurationError.new "No hostname defined" if !req_options[:base_uri] || req_options[:base_uri].empty?
         
-        # prepare request and sanitized request for logs
-        #puts "Options after strip unsafe: #{strip_unsafe_params(req_options)}"
-        #puts "options before that: #{req_options}"
-        #safe_req_options = strip_unsafe_params(req_options)
+        # prepare request
         req = HTTParty::Request.new http_method, path, req_options
-        #req_to_output = HTTParty::Request.new http_method, path, safe_req_options
-        # ap "HERE ARE THE INGREDIENTS OF THE REQUEST:"
-        # ap "http_method is: #{http_method}"
-        # ap "path is: #{path}"
-        # ap "req_options is: #{req_options}"
+
+        # Sanitized request for logs
+        safe_req_options = strip_unsafe_params(http_method, req_options)
+        req_to_output = HTTParty::Request.new http_method, path, safe_req_options
 
         begin
           response = req.perform
@@ -150,21 +172,20 @@ class CityGrid
           raise CityGridExceptions::RequestError.new req, ex
         ensure
           if defined?(Rails.logger)
-            Rails.logger.info req.to_curl
+            Rails.logger.info req_to_output.to_curl
           else
-            puts req.to_curl
-            ap response
+            puts req_to_output.to_curl
           end
         end
 
         begin 
           # catch unparsable responses (html etc)
           if !response.parsed_response.is_a?(Hash)
-            ap "[gem] the response was unparsable (response was not a hash)"
+            #ap "[gem] the response was unparsable (response was not a hash)"
             raise CityGridExceptions::ResponseParseError.new req, response
           # catch responses not in new response format
           elsif response["errors"]
-            ap "[gem] An error in the old response format was caught.  Raising a general response error..."
+            #ap "[gem] An error in the old response format was caught.  Raising a general response error..."
             raise CityGridExceptions::ResponseError.new req, response["errors"], response
 
           # Parse and handle new response codes 
@@ -172,23 +193,23 @@ class CityGrid
                 (response["response"] && response["response"]["code"] != 200) && 
                 (response["response"] && response["response"]["code"] != 400) 
             error_code = response["response"]["code"]
-            ap "[gem] The response was contained in the first level of the response hash.  Below:"
-            ap response
-            ap "found error code: #{error_code}"
-            ap "****************************************************************************"
+            #ap "[gem] The response was contained in the first level of the response hash.  Below:"
+            #ap response
+            #ap "found error code: #{error_code}"
+            #ap "****************************************************************************"
             raise CityGridExceptions.appropriate_error(error_code).new req, response, response["response"]["message"].to_s #+ " " + CityGridExceptions.print_superclasses(error_code)
           # if the response is a nested hash/nested hash containing arrays
           elsif response["totalNumEntries"] && response["response"].nil?
-            ap "[gem] now parsing a response with multiple entries: #{response}"
+            #ap "[gem] now parsing a response with multiple entries: #{response}"
             error_code = parse_multiple_responses(response)
-            ap "the error code that came back is #{error_code}"
+            #ap "the error code that came back is #{error_code}"
             if error_code.nil? || error_code == []
-              ap "[gem] passing over this for now"
+              #ap "[gem] passing over this for now"
               return CityGrid::API::Response.new response # pass over for now
             elsif error_code[0] == "SUCCESS" || error_code[0] == 200 || error_code[0] == 400
               return CityGrid::API::Response.new response
             else 
-              ap "[gem] we found an error and it was #{error_code[1]}"
+              #ap "[gem] we found an error and it was #{error_code[1]}"
                 raise CityGridExceptions.appropriate_error(error_code[0]).new req, response, error_code[1].to_s  + " "# + CityGridExceptions.print_superclasses(error_code[0])
             end
           else

data/test/api/accounts/test_temp_impersonation.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'helper'))
+
+context "impersonate user" do
+	setup do
+		SessionHelper.gary_test.call_api CityGrid::API::Accounts::TempImpersonation, :impersonate, :customerId => 125902
+	end
+	should("have a different auth token"){ap topic.authToken}
+end

data/test/api/accounts/test_user.rb

@@ -13,4 +13,11 @@ context "user log in with session" do
   end
   should("have an auth_token"){ topic.auth_token }
   should("be logged in"){ topic.logged_in? }
+end
+
+context "impersonate user" do
+	setup do
+		SessionHelper.gary_test.call_api CityGrid::API::Accounts::User, :impersonate, :customerId => 125902
+	end
+	should("have a different auth token"){ap topic.authToken}
 end

data/test/helper.rb

@@ -21,7 +21,7 @@ unless defined? IN_DASHBOARD
   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'))
 
   # CityGrid.load_config File.expand_path(File.join(File.dirname(__FILE__), '..', 'citygrid_api.yml.sandbox'))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: citygrid_api
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000Z
+date: 2012-03-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70321245070140 !ruby/object:Gem::Requirement
+  requirement: &70187366267200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70321245070140
+  version_requirements: *70187366267200
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70321245069540 !ruby/object:Gem::Requirement
+  requirement: &70187366266180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -33,10 +33,10 @@ dependencies:
         version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70321245069540
+  version_requirements: *70187366266180
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &70321245068820 !ruby/object:Gem::Requirement
+  requirement: &70187366264980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.12.4
   type: :runtime
   prerelease: false
-  version_requirements: *70321245068820
+  version_requirements: *70187366264980
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70321245068080 !ruby/object:Gem::Requirement
+  requirement: &70187366263960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70321245068080
+  version_requirements: *70187366263960
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70321245067160 !ruby/object:Gem::Requirement
+  requirement: &70187366262020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70321245067160
+  version_requirements: *70187366262020
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70321245063220 !ruby/object:Gem::Requirement
+  requirement: &70187366260260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *70321245063220
+  version_requirements: *70187366260260
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70321245062700 !ruby/object:Gem::Requirement
+  requirement: &70187366259520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70321245062700
+  version_requirements: *70187366259520
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70321245061660 !ruby/object:Gem::Requirement
+  requirement: &70187366248660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70321245061660
+  version_requirements: *70187366248660
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70321245059820 !ruby/object:Gem::Requirement
+  requirement: &70187366247360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70321245059820
+  version_requirements: *70187366247360
 description: Ruby wrapper for CityGrid APIs
 email: Joseph.Chen@citygridmedia.com
 executables: []
@@ -182,6 +182,7 @@ files:
 - lib/citygrid/api/accounts/account.rb
 - lib/citygrid/api/accounts/authentication.rb
 - lib/citygrid/api/accounts/method_of_payment.rb
+- lib/citygrid/api/accounts/temp_impersonation.rb
 - lib/citygrid/api/accounts/user.rb
 - lib/citygrid/api/advertising.rb
 - lib/citygrid/api/advertising/account_manager.rb
@@ -223,6 +224,7 @@ files:
 - public/javascript/dashboard.js
 - test/api/accounts/test_account.rb
 - test/api/accounts/test_method_of_payment.rb
+- test/api/accounts/test_temp_impersonation.rb
 - test/api/accounts/test_user.rb
 - test/api/advertising/test_account_manager.rb
 - test/api/advertising/test_ad_group.rb