citygrid_api 0.0.6 → 0.0.7

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

@@ -2,8 +2,8 @@ class CityGrid
   class API
     class Advertising
       class Category < Advertising
-        extend CityGrid::API::Mutatable
-        extend CityGrid::API::Searchable
+        include CityGrid::API::Mutable
+        include CityGrid::API::Searchable
       end
     end
   end

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

@@ -2,8 +2,8 @@ class CityGrid
   class API
     class Advertising
       class GeoLocation < Advertising
-        extend CityGrid::API::Mutatable
-        extend CityGrid::API::Searchable
+        include CityGrid::API::Mutable
+        include CityGrid::API::Searchable
       end
     end
   end

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

@@ -13,9 +13,9 @@ class CityGrid
             :body => {"mutateOperationListResource" => [
               {
                 "operand" => {
-                	"image_type" => type,
-                	"image_name" => name,
-                	"image_format" => format,
+                	"imageType" => type,
+                	"imageName" => name,
+                	"imageFormat" => format,
                 	"image" => image_data
                   },
                 "operator" => "ADD",

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

@@ -0,0 +1,10 @@
+class CityGrid
+  class API
+    class Advertising
+      class Offers < Advertising
+        include CityGrid::API::Mutable
+        include CityGrid::API::Searchable
+      end
+    end
+  end
+end

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

@@ -2,8 +2,8 @@ class CityGrid
   class API
     class Advertising
       class Places < Advertising
-        extend CityGrid::API::Mutatable
-        extend CityGrid::API::Searchable
+        include CityGrid::API::Mutable
+        include CityGrid::API::Searchable
       end
     end
   end

data/lib/citygrid/api/content/offers.rb

@@ -2,8 +2,17 @@ class CityGrid
   class API
     class Content
       class Offers < Content
-        define_action :where, :get, "search/where", :auth_token => false, :publisher => true, :client_ip => true
-        define_action :places, :get, "search/places", :auth_token => false, :publisher => true, :client_ip => true
+        define_action :where, :get, "search/where", 
+          :auth_token => false, 
+          :publisher => true, 
+          :client_ip => true, 
+          :format => true
+          
+        define_action :places, :get, "search/places",   
+          :auth_token => false, 
+          :publisher => true, 
+          :client_ip => true, 
+          :format => true
       end
     end
   end

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

@@ -2,7 +2,7 @@ class CityGrid
   class API
     class Content
       class Places < Content
-        extend CityGrid::API::Mutatable
+        include CityGrid::API::Mutable
         
         define_action :detail, :get, "detail", :auth_token => false, :publisher => true, :client_ip => true
         define_action :search, :get, "search/where", :auth_token => false, :publisher => true, :client_ip => true

data/lib/citygrid/api/content/response.rb

@@ -0,0 +1,14 @@
+class CityGrid
+  class API
+    class Content
+      class Response < Content
+        include CityGrid::API::Mutable
+        define_action :get, :get, "get",
+          :auth_token => true, 
+          :publisher => true, 
+          :client_ip => true, 
+          :format => true
+      end
+    end
+  end
+end

data/lib/citygrid/api/content/reviews.rb

@@ -2,8 +2,11 @@ class CityGrid
   class API
     class Content
       class Reviews < Content
-        base_uri "api.citygridmedia.com"
-        endpoint "/content/reviews/v2/search/where"
+        define_action :where, :get, "search/where",
+          :auth_token => false, 
+          :publisher => true, 
+          :client_ip => true, 
+          :format => true
       end
     end
   end

data/lib/citygrid/api/mutable.rb

@@ -0,0 +1,13 @@
+# /mutate endpoint
+
+class CityGrid
+  class API
+    module Mutable
+      def self.included base
+        base.define_action :mutate, :post, "mutate",
+          :auth_token => true,
+          :format => false
+      end
+    end
+  end
+end

data/lib/citygrid/api/searchable.rb

@@ -3,12 +3,10 @@
 class CityGrid
   class API
     module Searchable
-      def search options = {}
-        token = extract_auth_token options
-        request_and_handle :get, 
-          "#{endpoint}/get",
-          :query   => options,
-          :headers => merge_headers("authToken" => token)
+      def self.included base
+        base.define_action :search, :get, "get",
+          :auth_token => true,
+          :format => true
       end
     end
   end

data/lib/citygrid/api.rb

@@ -4,14 +4,13 @@ require "json"
 class CityGrid
   class API 
     include HTTParty
-    format :json
     #debug_output $stderr
 
     DEFAULT_HEADERS = {
       "Accept" => "application/json",
       "Content-Type" => "Application/JSON"}
     
-    DEFAULT_DEFINE_OPTIONS = {
+    DEFAULT_ACTION_OPTIONS = {
       :auth_token => false,
       :format     => true,
       :publisher  => false,
@@ -26,8 +25,8 @@ class CityGrid
         #    ip: pass IP, needed for content
         #    format: pass JSON flag 
         
-        define_options = DEFAULT_DEFINE_OPTIONS.merge define_options
-        
+        define_options = DEFAULT_ACTION_OPTIONS.merge define_options
+
         define_singleton_method name.intern do |*args|
           options = args.first.clone || {}
           params = {}
@@ -36,7 +35,7 @@ class CityGrid
           
           headers = API::DEFAULT_HEADERS.clone
           
-          headers.merge! "authToken" => token if define_options[:auth_token]
+          headers.merge! "authToken" => token if define_options[:auth_token] && token
 
           options.merge! "format"     => "json" if define_options[:format]
           options.merge! "publisher"  => CityGrid.publisher if define_options[:publisher]
@@ -91,66 +90,77 @@ class CityGrid
             http_method = HTTP_METHODS[http_method.to_s]
             raise "Unknown http method: #{http_method}" unless http_method
           end
-
+        
           req_options = default_options.dup
           req_options = req_options.merge(options)
-
+          
+          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?
+          
           req = HTTParty::Request.new http_method, path, req_options
-          error = nil
 
-          begin 
+
+          begin
             response = req.perform
           rescue => ex
-            puts "Something went wrong with Request.perform"
-            error = ex
-          rescue Psych::SyntaxError => ex
-            puts "Something went wrong with Request.perform, Psych:SyntaxError"
-            error = ex
-          end
-          
-          if defined?(Rails.logger)
-            Rails.logger.info req.to_curl
-          else
-            puts req.to_curl
-          end
-
-          unless error
-            if !response.parsed_response.is_a?(Hash)
-              error = InvalidResponseFormat.new response
-            elsif response["errors"]
-              error = Error.new response["errors"], response
+            raise RequestError.new req, ex
+          ensure
+            if defined?(Rails.logger)
+              Rails.logger.info req.to_curl
             else
-              return CityGrid::API::Response.new response
+              puts req.to_curl
             end
           end
           
-          if error 
-            puts "an error happened"
-            ap error
-            #raise error
+          if !response.parsed_response.is_a?(Hash)
+            raise ResponseParseError.new req, response
+          elsif response["errors"]
+            raise ResponseError.new req, response["errors"], response
+          elsif response["message"] && response["message"] == "Invalid Token or Expired"
+            raise InvalidAuthToken.new
+          else
+            return CityGrid::API::Response.new response
           end
+          
+        rescue => ex
+          raise ex if CityGrid.raise_errors?
         end
       end
 
       # ERRORS
-      class GenericError < StandardError
-        attr_reader :httparty, :message
-
-        def initialize msg, response = nil
-          @message  = msg
-          @httparty = response
+      class APIError < StandardError
+        attr_accessor :request
+        
+        def initialize msg, request
+          super msg
         end
       end
-
-      class Error < GenericError
-        def initialize errors, response
-          super errors.first["error"], response
+      
+      class ResponseError < APIError
+        attr_accessor :errors, :response
+        
+        def initialize request, errors, response
+          self.errors = errors
+          self.response = response
+          
+          super "API returned error message", request
         end
       end
-
-      class InvalidResponseFormat < GenericError
-        attr_accessor :server_msg, :description
-        def initialize response = nil
+      
+      class RequestError < APIError
+        attr_accessor :inner_exception
+        
+        def initialize request, inner_exception, msg = nil
+          self.inner_exception = inner_exception
+          self.request = request
+          super msg || "Error while performing request: #{inner_exception.message}", request
+        end
+      end
+      
+      class ResponseParseError < APIError
+        attr_accessor :server_msg, :description, :raw_response
+        def initialize request, response
+          self.raw_response = response
           # parse Tomcat error report
           if response.match /<title>Apache Tomcat.* - Error report<\/title>/
             response.scan(/<p><b>(message|description)<\/b> *<u>(.*?)<\/u><\/p>/).each do |match|
@@ -168,24 +178,32 @@ class CityGrid
             Unexpected response format. Expected response to be a hash, but was instead:\n#{error_body}\n
             EOS
 
-            super msg, error_body
+            super msg, request
           else
             msg = <<-EOS
             Unexpected response format. Expected response to be a hash, but was instead:\n#{response.parsed_response}\n
             EOS
 
-            super msg, response
+            super msg, request
           end
         end
       end
 
-      class MissingAuthToken < GenericError
-        def initialize
+      class InvalidAuthToken < StandardError
+        def initialize message = "Invalid Token or Expired"
           super message
         end
+      end
 
-        def message
-          "Missing authToken - token is required"
+      class MissingAuthToken < StandardError
+        def initialize
+          super "Missing authToken - token is required"
+        end
+      end
+      
+      class ConfigurationError < StandardError
+        def initialize message = "Invalid Configuration"
+          super message
         end
       end
     end

data/lib/citygrid/session.rb

@@ -26,19 +26,15 @@ class CityGrid
     end
     
     def login username, password
-      res = CityGrid::API::Accounts::Authentication.login :username => username, :password => password
+      res = CityGrid::API::Accounts::User.login :username => username, :password => password
       self.username = username
 
-      case res.code
-      when 201
-        self.auth_token = res.authToken
+
+      self.auth_token = res.authToken
+      if !auth_token.nil? && auth_token != ""
         self.logged_in = true
-        # puts "logged in ok"
-      when 400
-        # puts "error"
-      else
-        # puts "unexpected response code"  
       end
+
     end
     
     def call_api klass, action, options = {}

data/lib/citygrid.rb

@@ -16,7 +16,25 @@ class CityGrid
       raise PublisherNotConfigured if !defined?(@publisher) || @publisher.nil?
       @publisher
     end
+    
+    # whether api calls will throw errors or fail silently
+    # by default, we will raise errors
+    def raise_errors= v
+      @raise_errors = v
+    end
+    
+    def raise_errors? 
+      !defined?(@raise_errors) || @raise_errors
+    end
 
+    def use_vcr= v
+      @use_vcr = v
+    end
+    
+    def use_vcr?
+      defined?(VCR) && defined?(@use_vcr) && @use_vcr
+    end
+    
     def search opts = {}
       Search.new opts
     end
@@ -70,11 +88,13 @@ class CityGrid
             # if hostname is set, use it
             # otherwise if ssl is set then use ssl_hostname. fallback to default_hostname
             hostname = v["hostname"] || (v["ssl"] ? ssl_hostname : default_hostname)
+            throw ParseConfigurationError.new file_path, "No endpoint defined for #{k}" unless v["endpoint"]
             endpoint = v["endpoint"].start_with?("/") ? v["endpoint"] : "/#{v["endpoint"]}" 
             klass.endpoint endpoint
             klass.base_uri hostname
           else 
             # should not get here. value should be String or Hash
+            throw ParseConfigurationError.new file_path, "Invalid value type for #{k}"
           end
           
           # puts "#{klass.name} => #{klass.base_uri} : #{klass.endpoint}"
@@ -96,13 +116,20 @@ class CityGrid
       super "Endpoint is not properly configured. Run 'CityGrid.load_config'"
     end
   end
+  
+  class ParseConfigurationError < StandardError
+    def initialize path, msg = nil
+      super msg ? "#{msg} at '#{path}'" : "Error parsing configuration file at '#{path}'"
+    end
+  end
+  
 end
 
 require "citygrid/abstraction"
 require "citygrid/api"
 require "yaml"
 
-require "citygrid/api/mutatable"
+require "citygrid/api/mutable"
 require "citygrid/api/searchable"
 
 require "citygrid/search"

data/test/api/accounts/test_account.rb

@@ -19,7 +19,7 @@ context "search for an account" do
       run_with_rescue do
         SessionHelper.sales_coord.call_api CityGrid::API::Accounts::Account,
           :search,
-          :id    => 1250702
+          :id => 1250702
       end
     end
     should("not be empty"){ !topic.empty? }
@@ -57,9 +57,9 @@ context "import a cg account" do
             "phone"         => "9001111112", 
             "businessName"  =>"businessProveApi", 
             "address1"      =>"dir-api", 
-            "city" =>"montevideo", 
-            "state" =>"Montevideo", 
-            "zipCode" =>"90069" 
+            "city"          =>"montevideo", 
+            "state"         =>"Montevideo", 
+            "zipCode"       =>"90069" 
           } 
         }]
     end
@@ -72,38 +72,59 @@ end
 context "create an account" do
   set :vcr, false
   
-  username = "randuser_#{rand(10000000)}"
+  username = "randuser_9178989" # "randuser_#{rand(10000000)}"
+  email = "#{username}@a.com"
   password = "randuserpass"
   
-  setup do
-    SessionHelper.sales_coord.call_api CityGrid::API::Accounts::Account,
-      :mutate,
-      "mutateOperationListResource" => [{
-        "operator" => "ADD",
-        "operand"  => {
-          "firstName"    => "nico-api",
-          "lastName"     => "gomez-api",
-          "phone"        => "9001111112",
-          "email"        => "#{username}@a.com",
-          "userName"     => username,
-          "password"     => password,
-          "businessName" => "businessProveApi",
-          "address1"     => "dir-api",
-          "city"         => "montevideo",
-          "state"        => "Montevideo",
-          "zipCode"      => "90069"
-        }
-      }]
-  end
-  should("not be empty"){ !topic.empty? }
-  should("return message OK"){ topic.accountList.first.response.message }.equals("OK")  
-  should("return response code OK"){ topic.accountList.first.response.code.to_i }.equals(200)
-  
-  context "then logging in" do
+  # setup do
+  #   SessionHelper.sales_coord.call_api CityGrid::API::Accounts::Account,
+  #     :mutate,
+  #     "mutateOperationListResource" => [{
+  #       "operator" => "ADD",
+  #       "operand"  => {
+  #         "firstName"    => "nico-api",
+  #         "lastName"     => "gomez-api",
+  #         "phone"        => "9001111112",
+  #         "email"        => email,
+  #         "userName"     => username,
+  #         "password"     => password,
+  #         "businessName" => "businessProveApi",
+  #         "address1"     => "dir-api",
+  #         "city"         => "montevideo",
+  #         "state"        => "Montevideo",
+  #         "zipCode"      => "90069"
+  #       }
+  #     }]
+  # end
+  # should("not be empty"){ !topic.empty? }
+  # should("return message OK"){ topic.accountList.first.response.message }.equals("OK")  
+  # should("return response code OK"){ topic.accountList.first.response.code.to_i }.equals(200)
+  # 
+  # context "then logging in" do
+  #   setup do
+  #     CityGrid.login :username => username, :password => password
+  #   end
+  #   should("return an authToken"){ topic.authToken }
+  # end
+  # 
+  # context "then validate with session" do
+  #   setup do
+  #     session = CityGrid.session username, password
+  #     session.call_api CityGrid::API::Accounts::User, :validate, :oauth_token => session.auth_token
+  #   end
+  #   
+  #   should("match on display_name") { topic.display_name }.equals(username)
+  #   should("match on email") { topic.email }.equals(email)
+  # end
+  # 
+  context "then validate with raw API" do
     setup do
-      CityGrid.login :username => username, :password => password
+      session = CityGrid.session username, password
+      CityGrid::API::Accounts::User.validate :oauth_token => session.auth_token
     end
-    should("return an authToken"){ topic.authToken }
+    
+    should("match on display_name") { topic.display_name }.equals(username)
+    should("match on email") { topic.email }.equals(email)
   end
   
 end

data/test/api/accounts/test_method_of_payment.rb

@@ -1,50 +1,47 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'helper'))
 
-context "Method of Payment" do
-  context "search" do
-    setup do
-      run_with_rescue do
-        SessionHelper.kunimom.call_api CityGrid::API::Accounts::MethodOfPayment, 
-          :search, 
-          :accountId => 111
-      end
+context "search for mop by account_id" do
+  setup do
+    run_with_rescue do
+      SessionHelper.kunimom.call_api CityGrid::API::Accounts::MethodOfPayment, 
+        :search, 
+        :accountId => 111
     end
-    should("not be empty"){ !topic.empty?}
-    should("have MOP resources"){ !topic.mopResources.empty? }    
   end
+  should("not be empty"){ !topic.empty?}
+  should("have MOP resources"){ !topic.mopResources.empty? }    
+end
 
-  # API not working here
-  context "mutate" do
-    setup do
-      run_with_rescue do
-        SessionHelper.kunimom.call_api CityGrid::API::Accounts::MethodOfPayment, 
-          :mutate, 
-          "mutateOperationListResource" => [{
-            "operator" => "ADD",
-            "operand" => {
-              "cardNumber"      => "4112344112344113",
-              "expirationMonth" => 12,
-              "expirationYear"  => 2012,
-              "nameOnAccount"  => "Ara Tatous",
-              "cardType"        => "Visa",
-              "state"           => "NY" ,
-              "description"     => "test addMOP",
-              "firstName"       => "Ara",
-              "lastName"        => "Tatous",
-              "phoneNumber"     => "4252838811",
-              "address1"        => "3131 Montrose Ave",
-              "address2"        => "Apt. 9",
-              "city"            => "LaCrescenta",
-              "postalCode"      => "10016",
-              "accountId"       => 2458392,
-              "securityCode"    => "719",
-              "paymentType"     => "Credit Card"
-            }
-          }]
-       end
+context "create a mop" do
+  setup do
+    run_with_rescue do
+      SessionHelper.kunimom.call_api CityGrid::API::Accounts::MethodOfPayment, 
+        :mutate, 
+        "mutateOperationListResource" => [{
+          "operator" => "ADD",
+          "operand" => {
+            "cardNumber"      => "4112344112344113",
+            "expirationMonth" => 12,
+            "expirationYear"  => 2012,
+            "nameOnAccount"  => "Ara Tatous",
+            "cardType"        => "Visa",
+            "state"           => "NY" ,
+            "description"     => "test addMOP",
+            "firstName"       => "Ara",
+            "lastName"        => "Tatous",
+            "phoneNumber"     => "4252838811",
+            "address1"        => "3131 Montrose Ave",
+            "address2"        => "Apt. 9",
+            "city"            => "LaCrescenta",
+            "postalCode"      => "10016",
+            "accountId"       => 2458392,
+            "securityCode"    => "719",
+            "paymentType"     => "Credit Card"
+          }
+        }]
      end
-     should("not be empty"){ !topic.empty? }
-     should("return code OK"){ topic.resources.first.response.code }.equals(200)
-     should("return message OK") { topic.resources.first.response.message }.equals("OK")
    end
-end
+   should("not be empty"){ !topic.empty? }
+   should("return code OK"){ topic.resources.first.response.code }.equals(200)
+   should("return message OK") { topic.resources.first.response.message }.equals("OK")
+ end

data/test/api/accounts/test_user.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'helper'))
+
+context "user log in with raw API" do
+  setup do
+    CityGrid.login :username => "GARYTEST", :password => 'pppppp'
+  end
+  should("return an authToken"){ topic.authToken }
+end
+
+context "user log in with session" do
+  setup do
+    CityGrid.session "GARYTEST", "pppppp"
+  end
+  should("have an auth_token"){ topic.auth_token }
+  should("be logged in"){ topic.logged_in? }
+end