oi-api-ruby 0.1.1

data/lib/oi_api/client/data_transfers.rb

@@ -0,0 +1,31 @@
+module OiApi
+
+  class Client
+
+    module DataTransfers
+
+      def data_transfers(options = {})
+        get("/datatransfers/", options)
+      end
+
+      def data_transfer(data_transfer_id, options = {})
+        get("/datatransfers/#{data_transfer_id}/", options)
+      end
+
+      def create_data_transfer(offer_id, options = {})
+        post("/offers/#{offer_id}/datatransfers/", options)
+      end
+
+      def update_data_transfer(offer_id, data_transfer_id, options = {})
+        put("/offers/#{offer_id}/datatransfers/#{data_transfer_id}/", options)
+      end
+
+      def delete_data_transfer(data_transfer_id, options = {})
+        delete("/datatransfers/#{data_transfer_id}/", options)
+      end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/offers.rb

@@ -0,0 +1,32 @@
+module OiApi
+
+  class Client
+
+    module Offers
+
+      def offers(options = {})
+        self.class.get("/offers/", options_with_basic_auth(options))
+      end
+
+      def offer(offer_id, options = {})
+        self.class.get("/offers/#{offer_id}/", options_with_basic_auth(options))
+      end
+
+      def create_offer(options = {})
+        self.class.post('/offers/', options_with_basic_auth(options))
+      end
+
+      def update_offer(offer_id, options = {})
+        self.class.put("/offers/#{offer_id}/", options_with_basic_auth(options))
+      end
+
+      # DELETE not allowed for offers?
+      #def delete_offer(offer_id, options = {})
+      #  self.class.delete("/offers/#{offer_id}/", options_with_basic_auth(options))
+      #end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/reports.rb

@@ -0,0 +1,15 @@
+module OiApi
+
+  class Client
+
+    module Reports
+
+      def reports(options = {})
+        get '/reports/advertisers/', options
+      end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/subscriptions.rb

@@ -0,0 +1,23 @@
+module OiApi
+
+  class Client
+
+    module Subscriptions
+
+      def subscriptions(advertiser_id, options = {})
+        post "/advertisers/#{advertiser_id}/subscriptions/", options
+      end
+
+      def subscription(advertiser_id, subscription_id, options = {})
+        get "/advertisers/#{advertiser_id}/subscriptions/#{subscription_id}", options
+      end
+
+      def create_subscription(advertiser_id, options = {})
+        post "/advertisers/#{advertiser_id}/subscriptions/", options
+      end
+
+    end
+
+  end
+
+end

data/lib/oi_api/configuration.rb

@@ -0,0 +1,50 @@
+require 'oi_api/version'
+require 'pry'
+
+module OiApi
+
+  module Configuration
+
+    VALID_CONFIG_KEYS = [
+      :username,
+      :password,
+      :api_endpoint,
+      :user_agent,
+      :format,
+      :content_type,
+      :debug_output
+    ]
+
+    DEFAULT_API_ENDPOINT = 'https://oiapi.com/v1/'.freeze
+    DEFAULT_USER_AGENT   = "OiApiRuby Gem #{OiApi::VERSION}".freeze
+    DEFAULT_FORMAT       = :json
+    DEFAULT_CONTENT_TYPE = 'application/json'
+    DEFAULT_DEBUG_OUTPUT = false # $stdout
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def options
+      Hash[ *VALID_CONFIG_KEYS.map { |key| [key, public_send(key)] }.flatten ]
+    end
+
+    def reset
+      self.username      = nil
+      self.password      = nil
+      self.api_endpoint  = DEFAULT_API_ENDPOINT
+      self.user_agent    = DEFAULT_USER_AGENT
+      self.format        = DEFAULT_FORMAT
+      self.content_type  = DEFAULT_CONTENT_TYPE
+      self.debug_output  = DEFAULT_DEBUG_OUTPUT
+    end
+
+  end
+
+end

data/lib/oi_api/lookup_tables.rb

@@ -0,0 +1,42 @@
+module OiApi
+
+  module LookupTables
+
+    CATEGORIES = {
+      'Beauty & Fashion' => 1000,
+      'Business' => 1001,
+      'Entertainment' => 1002,
+      'Food & Dining' => 1003,
+      'Health & Fitness' => 1004,
+      'Home & Family' => 1005,
+      'Investing' => 1006,
+      'Market Research' => 1007,
+      'News & Education' => 1008,
+      'Personal Finance' => 1009,
+      'Retail & E-commerce' => 1010,
+      'Social' => 1011,
+      'Travel' => 1012,
+    }
+
+    DATA_POINTS = {
+      FN:  { dynamic_field_value: '#{FN}',  description: 'First Name' },
+      LN:  { dynamic_field_value: '#{LN}',  description: 'Last Name' },
+      EM:  { dynamic_field_value: '#{EM}',  description: 'Email' },
+      AD1: { dynamic_field_value: '#{AD1}', description: 'Street Address' },
+      CI:  { dynamic_field_value: '#{CI}',  description: 'City' },
+      ST:  { dynamic_field_value: '#{ST}',  description: 'State' },
+      PO:  { dynamic_field_value: '#{PO}',  description: 'Postal Code' },
+      CO:  { dynamic_field_value: '#{CO}',  description: 'Country' },
+      HP:  { dynamic_field_value: '#{HP}',  description: 'Home Phone Number' },
+      MP:  { dynamic_field_value: '#{MP}',  description: 'Mobile Phone Number' },
+      G:   { dynamic_field_value: '#{G}',   description: 'Gender' },
+      DOB: { dynamic_filed_value: '#{DOB}', description: 'Date of Birth' }
+    }
+
+    def category_names
+      CATEGORIES.keys
+    end
+
+  end
+
+end

data/lib/oi_api/version.rb

@@ -0,0 +1,3 @@
+module OiApi
+  VERSION = '0.1.1'
+end

data/oi-api-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oi_api/version'
+require 'yaml'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'oi-api-ruby'
+  spec.version       = OiApi::VERSION
+  spec.authors       = ['Jarrod Spillers']
+  spec.email         = ['jarrod@stacktact.com']
+  spec.description   = %q{Ruby client for Opt Intelligence API, http://www.opt-intelligence.com/}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/wmabee/oi-api-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'vcr', '~> 2.9.3'
+  spec.add_development_dependency 'dotenv', '~> 2.0.1'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+
+  spec.add_dependency 'httparty', '~> 0.13.3'
+end

data/spec/cassettes/OiApi_Client_Advertisers/_advertiser/it_should_behave_like_GET_resource/returns_200_OK.yml

@@ -0,0 +1,157 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:39 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '[{"id": 40334, "name": "new advertiser 1c86b9a567ea8a06040c2bd570c5007b",
+        "status_id": 1, "category_id": 1010, "key": "", "create_date": "2015-04-24T18:35:40",
+        "modify_date": "2015-04-24T18:35:40"}]'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:41 GMT
+- request:
+    method: delete
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/40334/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:39 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, PUT, DELETE, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"status": "Delete Successful", "message": "Advertiser Succesfully
+        deleted"}'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:41 GMT
+- request:
+    method: post
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/
+    body:
+      encoding: UTF-8
+      string: '{"name":"new advertiser c9badd7fc95376b2614fdbfbe77d19f9","status_id":1,"category_id":1010}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 201
+      message: CREATED
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:39 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"status": "Create Successful", "message": "Advertiser successfully
+        created", "id": 40335}'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:42 GMT
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/40335/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:40 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, PUT, DELETE, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"id": 40335, "name": "new advertiser c9badd7fc95376b2614fdbfbe77d19f9",
+        "status_id": 1, "category_id": 1010, "key": "", "create_date": "2015-04-24T18:35:41",
+        "modify_date": "2015-04-24T18:35:41"}'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:42 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/OiApi_Client_Advertisers/_advertiser/it_should_behave_like_GET_resource/returns_HTTParty_Response.yml

@@ -0,0 +1,157 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:40 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '[{"id": 40335, "name": "new advertiser c9badd7fc95376b2614fdbfbe77d19f9",
+        "status_id": 1, "category_id": 1010, "key": "", "create_date": "2015-04-24T18:35:41",
+        "modify_date": "2015-04-24T18:35:41"}]'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:42 GMT
+- request:
+    method: delete
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/40335/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:40 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, PUT, DELETE, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"status": "Delete Successful", "message": "Advertiser Succesfully
+        deleted"}'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:43 GMT
+- request:
+    method: post
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/
+    body:
+      encoding: UTF-8
+      string: '{"name":"new advertiser d4fcadac6e025ed4348d28dc5ab4f048","status_id":1,"category_id":1010}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 201
+      message: CREATED
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:41 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"status": "Create Successful", "message": "Advertiser successfully
+        created", "id": 40336}'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:43 GMT
+- request:
+    method: get
+    uri: https://<USERNAME>:<PASSWORD>@oiapi.com/v1/advertisers/40336/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - OiApiRuby Gem 0.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 24 Apr 2015 22:34:41 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      Vary:
+      - Accept,Cookie
+      X-Frame-Options:
+      - SAMEORIGIN
+      Allow:
+      - GET, PUT, DELETE, HEAD, OPTIONS
+      Connection:
+      - close
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"id": 40336, "name": "new advertiser d4fcadac6e025ed4348d28dc5ab4f048",
+        "status_id": 1, "category_id": 1010, "key": "", "create_date": "2015-04-24T18:35:43",
+        "modify_date": "2015-04-24T18:35:43"}'
+    http_version: 
+  recorded_at: Fri, 24 Apr 2015 22:35:43 GMT
+recorded_with: VCR 2.9.3