espresso_path 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c196fb46dcd16c49fd44b559427d37646dbbe149
-  data.tar.gz: 4a81ee522958f17fb0c77f2a329af9783398b388
+  metadata.gz: 782ffeb775af8ac72603913761b9d673a7014a61
+  data.tar.gz: 4fc4b1160addf1818b99c13d01f79c60e805338e
 SHA512:
-  metadata.gz: f32ab8d883a0690a042ae1b3181f3e134d448a779f34dfe45ad62e10132f046a402b50b77bde3cd8cd4fc894b48793c5966b4d1adb54fea6cda353c578c65e1e
-  data.tar.gz: b404c5ae1d945f192e9dbf4cc76b4cec6ae8dd97cb0214420a0513407c6c62ba1371cdb74ebfd8c2e038745fbdb8ff4fe6fd7024c5c3ce509549210997e8af9a
+  metadata.gz: 1940e193579f38dd7776d7ffa1f23cbf0275e526fef45e5f60474f14d5b8c2cab1270043393e0632154c879eb4375fe6236f58096b0a7bf8c049b6b146d799d1
+  data.tar.gz: ceba57d5a3da89bfc220f1e5b433800cf187d531f69b6ca147dad75e4bdbc9956681ba474afc0cfd1a4e4c3aacea68851631b7d5e3c5f9218c7853ea3627fc17

data/README.md

@@ -10,7 +10,7 @@ Welcome to your EspressoPath! Espresso Path is GeoPath API Ruby Wrapper
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'espresso_path', '~> 0.1.3'
+gem 'espresso_path', '~> 0.1.5'
 ```
 
 And then execute:

data/lib/espresso_path.rb

@@ -2,7 +2,6 @@ require "espresso_path/version"
 require 'espresso_path/configuration'
 require 'httparty'
 require 'json'
-require 'espresso_path/geo_path'
 require 'espresso_path/client'
 
 module EspressoPath

data/lib/espresso_path/client.rb

@@ -26,25 +26,62 @@ module EspressoPath
       @options = {
         headers: {
           Authorization: "Bearer #{@access_token}"
-        },
-
+        }
       }
     end
 
     def map_services(type, level, ids, options = @options)
-      options[:query] = { ids: ids}
-      puts options.inspect
+      options[:query] = { ids: ids }
       self.class.get("/mapservices/#{type}/#{level}", @options)
     end
 
-    def audience
-      self.class.get('/audience', @options)
-    end
-
+    # Get Audience
+    #
+    # # ==== Attributes
+    # * +daypart_ids+ - REQUIRED - Comma-separated list of daypart IDs.
+    # * +demo_ids+ - Optional - Comma-separated list of demo IDs. Either this or custom_demo_ids must be provided.
+    # * +custom_demo_ids+ - Optional - Comma-separated list of custom demo IDs. Either this or demo_ids must be provided.
+    # * +panel_ids+ - REQUIRED - Comma-separated list of panel IDs.
+    # * +market_id+ - REQUIRED - Market ID to get information for.
+    # * +population_base+ - REQUIRED - Base population.
+    def audience(daypart_ids, panel_ids, market_id, population_base, opts ={})
+      options = @options
+      options[:query] = { daypart_ids: daypart_ids, panel_ids: panel_ids, market_id: market_id,
+                          population_base: population_base }.merge(opts)
+      self.class.get('/audience', options)
+    end
+
+    # Get Home Audience
+    #
+    # # ==== Attributes
+    # * +daypart_id+ - REQUIRED - Daypart ID to look for.
+    # * +demo_id+ - Optional - Comma-separated list of demo IDs. Either this or custom_demo_ids must be provided.
+    # * +custom_demo_id+ - Optional - Comma-separated list of custom demo IDs. Either this or demo_ids must be provided.
+    # * +panel_ids+ - REQUIRED - Comma-separated list of panel IDs.
+    # * +market_id+ - REQUIRED - Market ID to get information for.
+    # * +population_base+ - REQUIRED - Base population.
+    # * +reporting_level+ - REQUIRED - Geo level to get homes for.
+    def audience_home(daypart_id, panel_ids, market_id, population_base, reporting_level, opts ={})
+      options = @options
+      options[:query] = { daypart_id: daypart_id, panel_ids: panel_ids,
+                          market_id: market_id, reporting_level: reporting_level,
+                          population_base: population_base }.merge(opts)
+      self.class.get('/audience/homes', options)
+    end
+
+    # Gets all Census Tracts
     def census_tracts
       self.class.get('/census-tracts', @options)
     end
 
+    # Gets specified Census Tract
+    # # ==== Attributes
+    #
+    # * +id+ - Required - Census TractID
+    def census_tract(id)
+      self.class.get("/census-tracts/#{id}", @options)
+    end
+
     def counties
       self.class.get('/counties', @options)
     end
@@ -53,6 +90,55 @@ module EspressoPath
       self.class.get('/custom-demos', @options)
     end
 
+    def custom_demo(id)
+      self.class.get("/custom-demos/#{id}", @options)
+    end
+
+    # Create a Custom Demographic
+    # # ==== Attributes
+    #
+    # * +name+ - Required - The name of demographic
+    # * +age_min+ - Optional - The minimum age in the custom demo
+    # * +age_max+ - Optional - The maximum age in the custom demo
+    # * +hhinc_min+ - Optional - The minimum household income in the custom demo
+    # * +hhinc_max+ - Optional - The maximum household income in the custom demo
+    # * +races+ - Optional - The races included in the custom demo. Supported values are white, black, amerindian, asian, pacific, other
+    # * +sex+ - Optional - The sex in the custom demo
+    # * +employed+ - Optional - The employment status in the custom demo
+    # * +audience+ - Required - Who can use this custom demo
+    def create_custom_demo(name, audience = 'company', opts = {})
+      options = @options
+      options[:query] = { name: name, audience: audience }.merge(opts)
+      self.class.post('/custom-demos', options)
+    end
+
+    # Update a Custom Demographic
+    # # ==== Attributes
+    #
+    # * +id+ - Required - Custom Demographic ID
+    # * +name+ - Optional - The name of demographic
+    # * +age_min+ - Optional - The minimum age in the custom demo
+    # * +age_max+ - Optional - The maximum age in the custom demo
+    # * +hhinc_min+ - Optional - The minimum household income in the custom demo
+    # * +hhinc_max+ - Optional - The maximum household income in the custom demo
+    # * +races+ - Optional - The races included in the custom demo. Supported values are white, black, amerindian, asian, pacific, other
+    # * +sex+ - Optional - The sex in the custom demo
+    # * +employed+ - Optional - The employment status in the custom demo
+    # * +audience+ - Optional - Who can use this custom demo
+    def update_custom_demo(id, opts = {})
+      options = @options
+      options[:query] = opts
+      self.class.put("/custom-demos/#{id}", options)
+    end
+
+    # Delete a Custom Demographic
+    # # ==== Attributes
+    #
+    # * +id+ - Required - Custom Demographic ID
+    def delete_custom_demo(id)
+      self.class.delete("/custom-demos/#{id}", @options)
+    end
+
     def custom_markets
       self.class.get('/custom-markets', @options)
     end
@@ -126,5 +212,7 @@ module EspressoPath
     def states
       self.class.get('/states', @options)
     end
+
+
   end
 end

data/lib/espresso_path/version.rb

@@ -1,3 +1,3 @@
 module EspressoPath
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: espresso_path
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - KickinEspresso
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -141,7 +141,6 @@ files:
 - lib/espresso_path.rb
 - lib/espresso_path/client.rb
 - lib/espresso_path/configuration.rb
-- lib/espresso_path/geo_path.rb
 - lib/espresso_path/models/market.rb
 - lib/espresso_path/version.rb
 - lib/generators/espresso_path/install_generator.rb

data/lib/espresso_path/geo_path.rb

@@ -1,80 +0,0 @@
-require 'logger'
-require 'httparty'
-require 'json'
-
-module EspressoPath
-  class GeoPath
-    include HTTParty
-    #base_uri 'insights-api.geopath.org'
-
-    def login
-      self.class.base_uri EspressoPath.configuration.base_url
-      uri = URI.parse(EspressoPath.configuration.base_url + "/login")
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.set_form_data({ :username => EspressoPath.configuration.user_name, :password => EspressoPath.configuration.password })
-
-      response = http.request(request)
-      body = JSON.parse(response.body)
-
-      @access_token = body["access_token"]
-
-      @options = {
-          headers: {
-              "Authorization"=> "Bearer #{@access_token}"
-          }
-      }
-    end
-
-    def audience
-      self.class.get("/audience", @options)
-    end
-
-    def day_parts
-      self.class.get("/day-parts", @options)
-    end
-
-    def counties
-      self.class.get("/counties", @options)
-    end
-
-    def custom_demos
-      self.class.get("/custom-demos", @options)
-    end
-
-    def media_types
-      self.class.get("/media-types", @options)
-    end
-
-    def operators
-      self.class.get("/operators", @options)
-    end
-
-    def plants
-      self.class.get("/plants", @options)
-    end
-
-    def markets
-      self.class.get("/markets", @options)
-    end
-
-    def market(market)
-      self.class.get("/markets/#{market}", @options)
-    end
-
-    def panels
-      self.class.get("/panels", @options)
-    end
-
-    def demo_categories
-      self.class.get("/demos/categories", @options)
-    end
-
-    def states
-      self.class.get("/states", @options)
-    end
-  end
-end