pocketmath-advertise 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c9ff5e64083c8fbfebd787eeea561cec50bdf79
-  data.tar.gz: 7f670f3d445182aa9a86728fc212bc0599ef85d9
+  metadata.gz: 1fa5aa04e223ff53658c46d7b519315fb79e8546
+  data.tar.gz: 0d3b61f58a15c21b323ccba55c2244fa82ab1d0e
 SHA512:
-  metadata.gz: 56289da6d8e1acc54fc44a68a5c29e50da6efbcee24aa5ab4b70bb0277684cf4542990b51a6b901d60915602381fe852cffe21735ac5ef3b10d85ec92df3bc5e
-  data.tar.gz: 277c043dfbee2c67a2989d7ee01f0ba85421deb8ede18226460d2c534d4924ff3bcc9497d906d161f5f37edebce4993095b5fa5cd1c5dee00e1dc8640e17ce9c
+  metadata.gz: ceade68a085ea00f3c7bdc1c5bb0b9516a90682135a13cd0ecac309fd74dbb4fe5a30f466a47eee6692a916ca337fc4545da638c3a3c33e2bfa181b8b5275e1b
+  data.tar.gz: e93f468332b6b9fb624148b0778a1631c2090007a113853213c456690bab303d64fa0e08029cc679ee1253ed5cc00fd28e43c5fc1c90ed3b8d040c5c46d724ea

data/lib/model/insertion_order_stats.rb

@@ -0,0 +1,42 @@
+module PocketMath::Advertiser::V1
+  
+  class InsertionOrderStats
+    
+    # Cost per thousand Impressions
+    attr_reader :cpm
+    
+    # Cost per Click
+    attr_reader :cpc
+    
+    # Cost per Action (Cost per Conversion)
+    attr_reader :cpa
+    
+    # Click-through Rate (Clicks per impression)
+    attr_reader :ctr
+    
+    attr_reader :impressions, :clicks, :conversions
+    
+    # Ad spend in currency
+    attr_reader :spend
+    
+    private
+    
+    attr_writer :cpm, :cpc, :cpa, :ctr
+    attr_writer :impressions, :clicks, :conversions
+    attr_writer :spend    
+    
+    public
+    
+    # Create a new instance.
+    # * Specify attributes in a hash as { :cpm => 1.25, :cpc => 2.33, ... }
+    def self.create(opts = {})
+      iostats = InsertionOrderStats.new
+      opts.each_pair do |k,v|
+        raise "#{k.to_s}=#{v} was not a number" if !v.is_a?(Numeric)
+        iostats.send(k.to_s + "=", v)
+      end
+    end
+    
+  end
+  
+end

data/lib/pocketmath-advertise.rb

@@ -1,2 +1,3 @@
 require 'pocketmath-geocode'
 require 'pocketmath-advertiser'
+require 'model/insertion_order_stats'

data/lib/pocketmath-advertiser.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'open-uri'
 require 'net/http'
 require 'net/https'
 require 'uri'
@@ -10,152 +9,213 @@ require 'curb'
 module PocketMath
   module PocketMath::Advertiser
     module PocketMath::Advertiser::V1
-    
-      API_BASE_URL = "https://api.pocketmath.com"
+      
+      DEFAULT_API_BASE_URL = "https://api.pocketmath.com"
+      
+      def self.open(pocketmath_api_key, pocketmath_api_base_url = DEFAULT_API_BASE_URL)
+        return Client.new(pocketmath_api_key, pocketmath_api_base_url)
+      end
+      
+      class PocketMath::Advertiser::V1::Client
+        
+        def initialize(pocketmath_api_key, pocketmath_api_base_url)
+          @pocketmath_api_key = pocketmath_api_key
+          @pocketmath_api_base_url = pocketmath_api_base_url
+        end
+        
+        def close
+        end
      
-      def self.find_gps_list_id_by_name(name)
-        p "get_gps_list_id"
-        url = "#{API_BASE_URL}/v1/lists/gps/list.json?token=#{POCKETMATH_API_KEY}&limit=10000"
-        response = Net::HTTP.get_response(URI.parse(url))
-        data = response.body
-        obj = JSON.parse(data)
-        obj.each do |result|
-          return result["id"] if result["name"] == name
+        def find_gps_list_id_by_name(name)
+          p "get_gps_list_id"
+          url = "#{@pocketmath_api_base_url}/v1/lists/gps/list.json?token=#{@pocketmath_api_key}&limit=10000"
+          response = Net::HTTP.get_response(URI.parse(url))
+          data = response.body
+          obj = JSON.parse(data)
+          obj.each do |result|
+            return result["id"] if result["name"] == name
+          end
         end
-      end
 
-      def self.create_gps_list(name)
-        raise "name was nil" if name.nil?
-        raise "name was blank" if name.empty? 
+        def create_gps_list(name)
+          raise "name was nil" if name.nil?
+          raise "name was blank" if name.empty? 
           
-        add_list_json = JSON::generate(
-           {
-             "token" => "#{POCKETMATH_API_KEY}",
-             "list" =>
-                {
-                   "name" => "#{name}"
-                }
-           })
+          add_list_json = JSON::generate(
+             {
+               "token" => "#{@pocketmath_api_key}",
+               "list" =>
+                  {
+                     "name" => "#{name}"
+                  }
+             })
      
-        uri = URI.parse(API_BASE_URL)
-        response = nil
-        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
-          request = Net::HTTP::Post.new("/v1/lists/gps/add_list.json")  
-          request.body = add_list_json
-          request.content_type = "application/json"
-          response = http.request(request)
-        end
-        if !response.nil?
-          data = response.body
-          obj = JSON::parse(data)
-          list_id = obj["id"]
-          return list_id
-        else
-          return nil
+          uri = URI.parse(@pocketmath_api_base_url)
+          response = nil
+          Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+            request = Net::HTTP::Post.new("/v1/lists/gps/add_list.json")  
+            request.body = add_list_json
+            request.content_type = "application/json"
+            response = http.request(request)
+          end
+          if !response.nil?
+            data = response.body
+            obj = JSON::parse(data)
+            list_id = obj["id"]
+            return list_id
+          else
+            return nil
+          end
         end
-      end
       
-      def self.upload_gps_list(id, coordinates = [])
-        raise "id was nil" if id.nil?
-        raise "coordinates was nil" if coordinates.nil?
-        raise "coordiantes was empty" if coordinates.empty?
+        def upload_gps_list(id, coordinates = [])
+          raise "id was nil" if id.nil?
+          raise "coordinates was nil" if coordinates.nil?
+          raise "coordiantes was empty" if coordinates.empty?
         
-        c = Curl::Easy.new("#{API_BASE_URL}/v1/lists/gps/upload.json")
-        c.multipart_form_post = true
+          c = Curl::Easy.new("#{@pocketmath_api_base_url}/v1/lists/gps/upload.json")
+          c.multipart_form_post = true
         
-        coordinates_string = ''
-        coordinates.each do |coord|
-          coordinates_string << "#{coord[:latitude]},#{coord[:longitude]}\r\n"
-        end
+          coordinates_string = ''
+          coordinates.each do |coord|
+            coordinates_string << "#{coord[:latitude]},#{coord[:longitude]}\r\n"
+          end
         
-        r = Random.new
-        remote_file_name = "pm-advert-client-gps-list-#{r.rand(2*1000*1000*1000)}-#{r.rand(2*1000*1000*1000)}.txt"
-        content_field = Curl::PostField.file('file', remote_file_name) do |field| 
-          field.content = coordinates_string
-        end
+          r = Random.new
+          remote_file_name = "pm-advert-client-gps-list-#{r.rand(2*1000*1000*1000)}-#{r.rand(2*1000*1000*1000)}.txt"
+          content_field = Curl::PostField.file('file', remote_file_name) do |field| 
+            field.content = coordinates_string
+          end
         
-        success = nil
+          success = nil
         
-        success = c.http_post(
-          content_field,
-          Curl::PostField.content('token', POCKETMATH_API_KEY),
-          Curl::PostField.content('mode', 'append'),
-          Curl::PostField.content('list_id', id.to_s )
-        )       
+          success = c.http_post(
+            content_field,
+            Curl::PostField.content('token', @pocketmath_api_key),
+            Curl::PostField.content('mode', 'append'),
+            Curl::PostField.content('list_id', id.to_s )
+          )       
 
-        return success
-      end
-      
-      private
-    
-      def self.deep_copy(o)
-        Marshal.load(Marshal.dump(o))
-      end    
-      
-      public
-      
-      def self.create_insertion_order( opts =
-        {
-          "name" => nil,
-          "start_datetime" => Date.now,
-          "end_datetime" => Date.now + 7.days,
-          "creative_type_ids" => [],
-          "budget" => "1.00",
-          "iab_catgories" => [],
-          "bid_per_impression" => "2.00",
-          "top_level_domain" => "pocketmath.com",
-          "country" => "223",
-          "image_url" => "https://s3.amazonaws.com/pocketmath/pocketmath_320x50.jpg",
-          "landing_page_url" => "www.pocketmath.com",
-          "size_id" => "11"
-        })
-        
-        o = deep_copy(opts)
-        
-        if o["name"].nil?
-          raise "name was nil"
+          return success
         end
         
-        if o["iab_category_codes"].empty?
-          raise "no iab_category_codes specified"
+        def get_insertion_order_stats(id, start_date = nil, end_date = nil)
+          url = "#{@pocketmath_api_base_url}/v1/stats/id.json?token=#{@pocketmath_api_key}&id=#{URI.encode(id)}"
+          start_date_string = to_date_string(start_date)
+          end_date_string = to_date_string(end_date)
+          url << "&start_date=#{URI.encode(start_date_string)}" if !start_date_string.nil?
+          url << "&end_date=#{URI.encode(end_date_string)}" if !end_date_string.nil?
+          uri = URI.parse(url)
+          
+          response = Net::HTTP.get(uri)
+          p response
+
+          if !response.nil?
+            data = response
+            obj = JSON::parse(data)
+            stats = obj["stats"]
+            return nil if stats.nil?
+            io_totals = stats["io_totals"]
+            return nil if io_totals.nil?
+            p io_totals
+            iostats = InsertionOrderStats.create({
+              :impressions => io_totals["imp"].to_i,
+              :clicks => io_totals["clk"].to_i,
+              :conversions => io_totals["conv"].to_i,
+              :spend => io_totals["spend"].gsub(/[^\d\.]/, '').to_f,
+              :cpm => io_totals["cpm"].gsub(/[^\d\.]/, '').to_f,
+              :cpc => io_totals["cpc"].gsub(/[^\d\.]/, '').to_f,
+              :cpa => io_totals["cpa"].gsub(/[^\d\.]/, '').to_f,
+              :ctr => io_totals["ctr"].to_f
+            })
+            return iostats
+          else
+            return nil
+          end          
         end
         
-        if o["start_datetime"].is_a?(Date)
-          o["start_datetime"] = o["start_datetime"].strftime("%d %b %Y")
-        elsif ! o["start_datetime"].is_a?(String)
-          raise "unsupported type"
+        private
+    
+        def deep_copy(o)
+          Marshal.load(Marshal.dump(o))
         end
         
-        if o["end_datetime"].is_a?(Date)
-          o["end_datetime"] = o["end_datetime"].strftime("%d %b %Y")
-        elsif ! o["end_datetime"].is_a?(String)
-          raise "unsupported type"
+        def to_date_string(o)
+          if o.nil?
+            return nil
+          elsif o.is_a?(Date)
+            return o.strftime("%d %b %Y")
+          elsif o.is_a?(String)
+            raise "case not handled"
+          end
         end
+      
+        public
+      
+        def create_insertion_order( opts =
+          {
+            "name" => nil,
+            "start_datetime" => Date.now,
+            "end_datetime" => Date.now + 7.days,
+            "creative_type_ids" => [],
+            "budget" => "1.00",
+            "iab_catgories" => [],
+            "bid_per_impression" => "2.00",
+            "top_level_domain" => "pocketmath.com",
+            "country" => "223",
+            "image_url" => "https://s3.amazonaws.com/pocketmath/pocketmath_320x50.jpg",
+            "landing_page_url" => "www.pocketmath.com",
+            "size_id" => "11"
+          })
         
-        obj = { "token" => POCKETMATH_API_KEY, "io" => o }
+          o = deep_copy(opts)
         
-        create_io_json = JSON.generate(obj)
+          if o["name"].nil?
+            raise "name was nil"
+          end
         
-        uri = URI.parse(API_BASE_URL)
-        response = nil
-        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
-          request = Net::HTTP::Post.new("/v1/io/create.json")  
-          request.body = create_io_json
-          request.content_type = "application/json"
-          response = http.request(request)
-        end
-        if !response.nil?
-          data = response.body
-          p response
-          p data
-          obj = JSON::parse(data)
-          io_id = obj["id"]
-          return io_id
-        else
-          return nil
-        end
+          if o["iab_category_codes"].empty?
+            raise "no iab_category_codes specified"
+          end
         
-      end
+          if o["start_datetime"].is_a?(Date)
+            o["start_datetime"] = o["start_datetime"].strftime("%d %b %Y")
+          elsif ! o["start_datetime"].is_a?(String)
+            raise "unsupported type"
+          end
+        
+          if o["end_datetime"].is_a?(Date)
+            o["end_datetime"] = o["end_datetime"].strftime("%d %b %Y")
+          elsif ! o["end_datetime"].is_a?(String)
+            raise "unsupported type"
+          end
+        
+          obj = { "token" => @pocketmath_api_key, "io" => o }
+        
+          create_io_json = JSON.generate(obj)
+        
+          uri = URI.parse(@pocketmath_api_base_url)
+          response = nil
+          Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+            request = Net::HTTP::Post.new("/v1/io/create.json")  
+            request.body = create_io_json
+            request.content_type = "application/json"
+            response = http.request(request)
+          end
+          if !response.nil?
+            data = response.body
+            p response
+            p data
+            obj = JSON::parse(data)
+            io_id = obj["id"]
+            return io_id
+          else
+            return nil
+          end
+        
+        end
+      
+      end # end Client
       
     end # module PocketMath::Advertiser::V1
   end # module PocketMath::Advertiser

data/lib/pocketmath-geocode.rb

@@ -1,73 +1,113 @@
 require 'json'
-require 'open-uri'
 require 'net/http'
 require 'uri'
 
-GEOCODING_PROVIDER = :open # May also use :google (see Google Map API Terms of Service to determine licensing requirements)
-
 module PocketMath
   module PocketMath::Geocode
 
-    private 
+    DEFAULT_GEOCODING_PROVIDER = :open # May also use :google (see Google Map API Terms of Service to determine licensing requirements)
 
-    def self.get_gps_coordinates_open(location, max_results = 1)
-      url = "http://open.mapquestapi.com/geocoding/v1/address?key=#{MAPQUEST_API_KEY}&location=#{URI.encode(location)}&maxResults=#{max_results.to_s}&inFormat=kvp&outFormat=json&json=true"
-      response = Net::HTTP.get_response(URI.parse(url))
-      data = response.body
-      obj = JSON.parse(data)
-      p url
-      p obj
-      gps_coordinates = []
-      obj["results"].each do |result|
-        result["locations"].each do |location|
-          lat_lng = location["latLng"]
-          gps_coordinates << { :latitude => lat_lng["lat"], :longitude => lat_lng["lng"] }
+    def self.open( opts = { :mapquest_api_key => nil, :provider => DEFAULT_GEOCODING_PROVIDER } )
+      return Geocode::Client.new(opts)
+    end
+    
+    class PocketMath::Geocode::Client
+    
+      private
+    
+      def initialize( opts = { :mapquest_api_key => nil, :provider => DEFAULT_GEOCODING_PROVIDER } )
+        if !opts[:provider].nil?
+          @provider = opts[:provider]
+        else 
+          @provider = DEFAULT_GEOCODING_PROVIDER
+        end
+
+        if !opts[:mapquest_api_key].nil?
+          @mapquest_api_key = opts[:mapquest_api_key]
+        else
+          @mapquest_api_key = nil
+        end
+
+        if @provider == :open && @mapquest_api_key.nil?
+          raise "Geocoding provider OPEN requires MapQuest API key.  No key was specified.  Please specify like this:  Geocode.open{ :mapquest_api_key => \"...\" }"
         end
       end
-      return nil if gps_coordinates.empty?
-      return gps_coordinates
-    end
 
-    private 
+      private 
 
-    #
-    # Use of the Google Map API requires licensing from Google.
-    #
-    def self.get_gps_coordinates_google(location, max_results = 1)
-      url = "http://maps.googleapis.com/maps/api/geocode/json?address=#{URI.encode(location)}&sensor=true"
-      response = Net::HTTP.get_response(URI.parse(url))
-      data = response.body
-      obj = JSON.parse(data)
-      p url
-      p obj
-      gps_coordinates = []
-      n = 0
-      obj["results"].each do |result|
-        break if n >= max_results
-        geometry = result["geometry"]
-        raise "geometry was unavailable" if geometry.nil?
-        location = geometry["location"]
-        raise "location was unavailable" if location.nil?
-        lat = location["lat"]
-        lng = location["lng"]
-        gps_coordinates << { :latitude => lat, :longitude => lng }
-        n += 1
+      def get_gps_coordinates_open(location, max_results = 1)
+        url = "http://open.mapquestapi.com/geocoding/v1/address?key=#{@mapquest_api_key}&location=#{URI.encode(location)}&maxResults=#{max_results.to_s}&inFormat=kvp&outFormat=json&json=true"
+        response = Net::HTTP.get_response(URI.parse(url))
+        data = response.body
+        obj = JSON.parse(data)
+        p url
+        p obj
+        gps_coordinates = []
+        obj["results"].each do |result|
+          result["locations"].each do |location|
+            lat_lng = location["latLng"]
+            gps_coordinates << { :latitude => lat_lng["lat"], :longitude => lat_lng["lng"] }
+          end
+        end
+        return nil if gps_coordinates.empty?
+        return gps_coordinates
       end
-      return nil if gps_coordinates.empty?
-      return gps_coordinates  
-    end
 
-    public
+      private 
 
-    def self.get_gps_coordinates(location, max_results = 1)
-      if GEOCODING_PROVIDER == :google
-        return get_gps_coordinates_google(location, max_results)
-      elsif GEOCODING_PROVIDER == :open
-        return get_gps_coordinates_open(location, max_results)
-      else
-        raise "map provider was not specified"
+      #
+      # Use of the Google Map API requires licensing from Google.
+      #
+      def get_gps_coordinates_google(location, max_results = 1)
+        url = "http://maps.googleapis.com/maps/api/geocode/json?address=#{URI.encode(location)}&sensor=true"
+        response = Net::HTTP.get_response(URI.parse(url))
+        data = response.body
+        obj = JSON.parse(data)
+        p url
+        p obj
+        gps_coordinates = []
+        n = 0
+        obj["results"].each do |result|
+          break if n >= max_results
+          geometry = result["geometry"]
+          raise "geometry was unavailable" if geometry.nil?
+          location = geometry["location"]
+          raise "location was unavailable" if location.nil?
+          lat = location["lat"]
+          lng = location["lng"]
+          gps_coordinates << { :latitude => lat, :longitude => lng }
+          n += 1
+        end
+        return nil if gps_coordinates.empty?
+        return gps_coordinates  
       end
-    end
 
+      public
+
+      def get_gps_coordinates(locations, max_results = 1)
+        _locations = nil
+        if (!locations.is_a?(Array))
+          _locations = [ locations ]
+        else
+          _locations = locations
+        end
+        gps_coordinates = []        
+        _locations.each do |location|
+          if @provider == :google
+            gps_coordinates = gps_coordinates + get_gps_coordinates_google(location, max_results)
+          elsif @provider == :open
+            gps_coordinates = gps_coordinates + get_gps_coordinates_open(location, max_results)
+          else
+            raise "map provider was not specified"
+          end
+        end
+        gps_coodinates = gps_coordinates.zip
+        return gps_coordinates
+      end
+    
+      def close
+      end
+
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocketmath-advertise
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Eric Tucker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -16,20 +16,27 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.5
 description: A client to connect to the PocketMath advertising API.
 email: eric@pocketmath.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/model/insertion_order_stats.rb
 - lib/pocketmath-advertise.rb
 - lib/pocketmath-advertiser.rb
 - lib/pocketmath-geocode.rb