citygrid_api 0.0.5.1 → 0.0.6

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

@@ -0,0 +1,10 @@
+class CityGrid
+  class API
+    class Advertising
+      class Places < Advertising
+        extend CityGrid::API::Mutatable
+        extend CityGrid::API::Searchable
+      end
+    end
+  end
+end

data/lib/citygrid/api/advertising.rb

@@ -0,0 +1,10 @@
+class CityGrid
+  class API
+    class Advertising < API
+    end
+  end
+end
+
+CityGrid::API::AdCenter = CityGrid::API::Advertising # backwards compat
+
+Dir[File.dirname(__FILE__) + '/advertising/*.rb'].each {|file| require file }

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

@@ -2,18 +2,8 @@ class CityGrid
   class API
     class Content
       class Offers < Content
-        @base_endpoint = "http://api.citygridmedia.com/content/offers/v2/search"
-        endpoint @base_endpoint
-        
-        def self.where options = {}
-          endpoint "#{@base_endpoint}/where"
-          request_with_publisher options
-        end
-        
-        def self.places options = {}
-          endpoint "#{@base_endpoint}/places"
-          request_with_publisher options
-        end
+        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
       end
     end
   end

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

@@ -2,35 +2,13 @@ class CityGrid
   class API
     class Content
       class Places < Content
-        base_uri "api.citygridmedia.com"
-        endpoint "/content/places/v2"
+        extend CityGrid::API::Mutatable
         
-        class << self
-          def detail opts
-            Detail.request opts
-          end
-
-          def search opts
-            Search.request opts
-          end
-          
-          def mutate options = {}
-            token = extract_auth_token options
-            request_and_handle :post,
-              "#{endpoint}/mutate",
-              :body    => options.to_json,
-              :headers => merge_headers("authToken" => token)
-          end
-          
-        end
+        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
       end
     end
   end
 end
 
-[
-  "detail", "search"
-].each do |x|
-  require "citygrid/api/content/places/#{x}"  
-end
-
+Dir[File.dirname(__FILE__) + '/places/*.rb'].each {|file| require file }

data/lib/citygrid/api/content.rb

@@ -5,8 +5,4 @@ class CityGrid
   end
 end
 
-[
-  "offers", "places", "reviews"
-].each do |x|
-  require "citygrid/api/content/#{x}"  
-end
+Dir[File.dirname(__FILE__) + '/content/*.rb'].each {|file| require file }

data/lib/citygrid/api/mutatable.rb

@@ -0,0 +1,15 @@
+# /mutate endpoint
+
+class CityGrid
+  class API
+    module Mutatable
+      def mutate options = {}
+        token = extract_auth_token options
+        request_and_handle :post,
+          "#{endpoint}/mutate",
+          :body    => options.to_json,
+          :headers => merge_headers("authToken" => token)
+      end
+    end
+  end
+end

data/lib/citygrid/api/searchable.rb

@@ -0,0 +1,15 @@
+# /get endpoint
+
+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)
+      end
+    end
+  end
+end

data/lib/citygrid/api.rb

@@ -7,69 +7,72 @@ class CityGrid
     format :json
     #debug_output $stderr
 
+    DEFAULT_HEADERS = {
+      "Accept" => "application/json",
+      "Content-Type" => "Application/JSON"}
+    
+    DEFAULT_DEFINE_OPTIONS = {
+      :auth_token => false,
+      :format     => true,
+      :publisher  => false,
+      :client_ip  => false
+    }
+    
     class << self   
-      # server setting - :default or :ssl       
-      def server val=nil
-        return @server || (superclass.respond_to?(:server) ? superclass.server : nil) unless val
-        @server = val
-      end
+      def define_action name, method, action, define_options = {}
+        # options: 
+        #    auth_token: pass along auth_token
+        #    publisher: pass CityGrid.publisher, currently needed for content APIs
+        #    ip: pass IP, needed for content
+        #    format: pass JSON flag 
+        
+        define_options = DEFAULT_DEFINE_OPTIONS.merge define_options
+        
+        define_singleton_method name.intern do |*args|
+          options = args.first.clone || {}
+          params = {}
+          
+          token = options.delete :token
+          
+          headers = API::DEFAULT_HEADERS.clone
+          
+          headers.merge! "authToken" => token if define_options[:auth_token]
 
-      def hostname val=nil
-        return @hostname || (superclass.respond_to?(:hostname) ? superclass.hostname : nil) unless val
-        @hostname = val
+          options.merge! "format"     => "json" if define_options[:format]
+          options.merge! "publisher"  => CityGrid.publisher if define_options[:publisher]
+          options.merge! "client_ip"  => "192.168.0.1" if define_options[:client_ip]
+          
+          params[:headers] = headers
+          
+          case method
+          when :post
+            params[:body] = options.to_json
+          when :get
+            params[:query] = options
+          end
+          
+          request_and_handle method.intern, "#{endpoint}/#{action}", params
+        end
       end
-
-      def endpoint val=nil
+      
+      def endpoint val = nil
         return @endpoint unless val
         @endpoint = val
       end
 
-      def publisher
-        CityGrid.publisher
-      end
-
       def request options = {}
         method = (options.delete(:method) || :get).to_sym
         query  = options.merge :format => :json
         request_and_handle method, endpoint, :query => query
       end
 
-      def request_with_publisher options = {}
-        request options.merge(:publisher => publisher)
-      end
-
-      def mutate options = {}
-        token = extract_auth_token options
-        request_and_handle :post,
-          "#{endpoint}/mutate",
-          :body    => options.to_json,
-          :headers => merge_headers("authToken" => token)
-      end
-
-      def search options = {}
-        token = extract_auth_token options
-        request_and_handle :get, 
-          "#{endpoint}/get",
-          :query   => options,
-          :headers => merge_headers("authToken" => token)
-      end
-
       private
-      def extract_auth_token options = {}
-        options.delete(:token) #|| raise(MissingAuthToken)
-      end
-
-      def merge_headers options = {}
-        {"Accept"       => "application/json",
-          "Content-Type" => "Application/JSON"}.merge options
+        def extract_auth_token options = {}
+          options.delete(:token) #|| raise(MissingAuthToken)
         end
-
-        def convert_to_querystring hash
-          hash.map do |k, v|
-            key = URI.escape k.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
-            val = URI.escape v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
-            !value.empty? && !key.empty? ? "#{key}=#{value}" : nil
-          end.compact.join("&")
+        
+        def merge_headers options = {}
+          DEFAULT_HEADERS.merge options
         end
 
         HTTP_METHODS = {
@@ -90,7 +93,6 @@ class CityGrid
           end
 
           req_options = default_options.dup
-          req_options = req_options.merge({:base_uri => CityGrid.config[server]}) if !base_uri && server
           req_options = req_options.merge(options)
 
           req = HTTParty::Request.new http_method, path, req_options
@@ -100,10 +102,10 @@ class CityGrid
             response = req.perform
           rescue => ex
             puts "Something went wrong with Request.perform"
-            error = StandardError.new "Internal Error"
+            error = ex
           rescue Psych::SyntaxError => ex
             puts "Something went wrong with Request.perform, Psych:SyntaxError"
-            error = StandardError.new "Internal Error"
+            error = ex
           end
           
           if defined?(Rails.logger)
@@ -124,7 +126,7 @@ class CityGrid
           
           if error 
             puts "an error happened"
-            puts req.to_json
+            ap error
             #raise error
           end
         end

data/lib/citygrid/details.rb

@@ -1,11 +1,8 @@
 class CityGrid
   module DetailsMethods
-    def api
-      CityGrid::API::Content::Places::Detail
-    end
-
-    def request opts = {}
-      api.request_with_publisher opts.merge(:client_ip => "192.168.0.1")
+    
+    def request options = {}
+      CityGrid::API::Content::Places.detail options
     end
   end
 

data/lib/citygrid/offers.rb

@@ -1,11 +1,7 @@
 class CityGrid
   class Offers < Abstraction::Collection
-    def api
-      CityGrid::API::Content::Offers
-    end
-
     def request opts = {}
-      api.request_with_publisher opts
+      CityGrid::API::Content::Offers.search opts
     end
 
     private

data/lib/citygrid/search.rb

@@ -1,11 +1,8 @@
 class CityGrid
   class Search < Abstraction::Collection
-    def api
-      CityGrid::API::Content::Places::Search
-    end
-
-    def request opts = {}
-      api.request_with_publisher opts
+    
+    def request options = {}
+      CityGrid::API::Content::Places.search options
     end
 
     private

data/lib/citygrid/session.rb

@@ -0,0 +1,65 @@
+class CityGrid
+  class Session
+    class APIAccessor
+      attr_accessor :session
+      
+      def initialize session
+        self.session = session
+      end
+      
+      def content klass
+      end
+      
+      def ad_center klass
+      end
+    end
+    
+    attr_accessor :username, :auth_token, :logged_in, :api
+    
+    def initialize
+      self.logged_in = false
+      self.api = {:ad_center => 1, :content => 2}
+    end
+    
+    def logged_in?
+      self.logged_in == true
+    end
+    
+    def login username, password
+      res = CityGrid::API::Accounts::Authentication.login :username => username, :password => password
+      self.username = username
+
+      case res.code
+      when 201
+        self.auth_token = res.authToken
+        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 = {}
+      klass.send action, options.merge(:token => self.auth_token)
+    end
+    
+    class << self
+      def login username, password
+        session = Session.new
+        session.login username, password
+        
+        session
+      end
+      
+      def from_auth_token auth_token
+        session = Session.new
+        session.auth_token = auth_token
+        session.logged_in = true
+        
+        session
+      end
+    end
+  end
+end

data/lib/citygrid.rb

@@ -2,6 +2,10 @@
 # Ruby 1.8.7 doesn't have YAML::ENGINE, this should take care of both cases
 YAML::ENGINE.yamler= 'syck' if defined?(YAML::ENGINE)
 
+# load monkey patches
+require "string_ext"
+require "request_ext"
+
 class CityGrid
   class << self
     def publisher= code
@@ -28,13 +32,18 @@ class CityGrid
     def reviews opts
       Reviews.new opts
     end
-
+    
+    def session username, password
+      Session.login username, password
+    end
+    
     def authenticate params
-      API::AdCenter::Authentication.login params
+      API::Accounts::User.login params
     end
     alias_method :login, :authenticate
     
-    # config info
+    # load in configs
+    # see citygrid_api.yml.sample for format
     def load_config file_path, env = nil
       config = YAML.load_file(file_path)
       
@@ -42,58 +51,36 @@ class CityGrid
       
       default_hostname = "http://#{defaults["hostname"]}"
       ssl_hostname = "https://#{defaults["ssl_hostname"]}"
-      
-      config["endpoints"].each do |k, v|
-        # camelcase classname
-        classname = k.gsub(/(_(.))/) { $2.upcase}.gsub(/^(.)/) { $1.upcase }
-        klass = API::AdCenter.const_get(classname)
-        if v.is_a? String
-          endpoint = v.start_with?("/") ? v : "/#{v}"
-          klass.endpoint endpoint
-          klass.base_uri default_hostname
-        elsif v.is_a? Hash
-          hostname = v["hostname"] || (v["ssl"] ? ssl_hostname : default_hostname)
 
-          endpoint = v["endpoint"].start_with?("/") ? v["endpoint"] : "/#{v["endpoint"]}" 
-          klass.endpoint endpoint
-          klass.base_uri hostname
-        else 
-          # should not get here
-        end
-      end
-    end
-    
-    def config
-      raise EndpointsNotConfigured unless @config && !@config.nil?
-      @config
-    end
-    
-    def set_endpoints config_file
-      File.open config_file, "r" do |file|
-        while line = file.gets
-          api, endpoint = line.split("=").map{|x| x.chomp}
-          endpoint = "/#{endpoint}" unless endpoint.start_with?("/")
-          klass = CLASS_MAPPING[api]
-          next unless klass
+      config["api"].each do |n, endpoints|
+        # namespace would be ad_center or content
+        namespace = API.const_get n.camelcase
+
+        endpoints.each do |k, v|
+          # camelcase classname
+          klass = namespace.const_get(k.camelcase)
           
-          klass.endpoint endpoint
-        end
-      end
-    end
-    
-    def set_env config_file
-      File.open config_file, "r" do |file|
-        while line = file.gets
-          api, host = line.split("=").map{|x| x.chomp}
-          host = "http://#{host}" unless host.start_with?("http")
-          klass = CLASS_MAPPING[api]
-          next unless klass
+          if v.is_a? String
+            # if value is a plain String, that's the endpoint
+            endpoint = v.start_with?("/") ? v : "/#{v}"
+            klass.endpoint endpoint
+            klass.base_uri default_hostname
+          elsif v.is_a? Hash
+            # if value is a Hash, fetch endpoint
+            # 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)
+            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
+          end
           
-          klass.base_uri host
+          # puts "#{klass.name} => #{klass.base_uri} : #{klass.endpoint}"
         end
       end
     end
-    
   end
 
   # Errors
@@ -106,45 +93,29 @@ class CityGrid
   
   class EndpointsNotConfigured < StandardError
     def initialize
-      super "Endpoints haven't been configured. Run 'CityGrid.load_config'"
+      super "Endpoint is not properly configured. Run 'CityGrid.load_config'"
     end
   end
 end
 
 require "citygrid/abstraction"
 require "citygrid/api"
+require "yaml"
+
+require "citygrid/api/mutatable"
+require "citygrid/api/searchable"
 
 require "citygrid/search"
 require "citygrid/reviews"
 require "citygrid/offers"
 require "citygrid/details"
 require "citygrid/listing"
+require "citygrid/session"
 
 require "citygrid/api/response"
-require "citygrid/api/ad_center"
-require "citygrid/api/content"
 
-require "request_ext"
+require "citygrid/api/accounts"
+require "citygrid/api/advertising"
+require "citygrid/api/content"
 
-class CityGrid
-  CLASS_MAPPING = {
-    "account"               => CityGrid::API::AdCenter::Account,
-    "accountmanager"        => CityGrid::API::AdCenter::AccountManager,
-    "adgroup"               => CityGrid::API::AdCenter::AdGroup,
-    "adgroupad"             => CityGrid::API::AdCenter::AdGroupAd,
-    "adgroupgeo"            => CityGrid::API::AdCenter::AdGroupGeo,
-    "billing"               => CityGrid::API::AdCenter::Billing,
-    "adgroupcriterion"      => CityGrid::API::AdCenter::AdGroupCriterion,
-    "authentication"        => CityGrid::API::AdCenter::Authentication,      
-    "budget"                => CityGrid::API::AdCenter::Budget,
-    "campaign"              => CityGrid::API::AdCenter::Campaign,
-    "category"              => CityGrid::API::AdCenter::Category,
-    "geolocation"           => CityGrid::API::AdCenter::GeoLocation,
-    "mop"                   => CityGrid::API::AdCenter::MethodOfPayment,
-    "image"                 => CityGrid::API::AdCenter::Image,
-    "places"                => CityGrid::API::AdCenter::Places,
-    "performance"           => CityGrid::API::AdCenter::Performance,
-    # "reviews"             => CityGrid::API::AdCenter::Reviews
-    "user"                  => CityGrid::API::AdCenter::User
-  }
-end
+require "request_ext"

data/lib/request_ext.rb

@@ -1,14 +1,13 @@
 module HTTParty
   class Request
 
+    # HTTParty::Request does some weird things with url params (namely, repeating them)
+    # use last_uri if it exists
     def get_uri
-      if (self.respond_to?('last_uri') && last_uri)
-        return last_uri
-      else
-        return uri
-      end
+      (self.respond_to?('last_uri') && last_uri) ? last_uri : uri
     end
     
+    # monkey patch to_json and to_curl methods into Request
     def to_json
       {
         "requestUrl" => get_uri,

data/lib/string_ext.rb

@@ -0,0 +1,7 @@
+# monkey patch camel-casing
+
+class String
+  def camelcase
+    self.gsub(/(_(.))/) { $2.upcase}.gsub(/^(.)/) { $1.upcase }
+  end
+end