adroller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b70f68db5e60c43d61d3e1eabb3c07ceb71725db
+  data.tar.gz: 4e6fb61791a8b1009e503a2112b498c41c23a454
+SHA512:
+  metadata.gz: 38893a8d653cb7af17aa0127ea798b05cb0640ff1ba1f971c53e44531f04b9a103708d9678066dc0ccd4ec892f6dac6242b12625edc5ab3efa3363b7f7996c60
+  data.tar.gz: 0ef1de8d7a826164a94768d0446f1b8fa5e79c6207fdc8f275306298965fb198e011684b856393d67a93d1d2d70deb37807b23c4565e8c8c8cd5d097cd448cd1

data/.gitignore

@@ -0,0 +1,15 @@
+/config/application.yml
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-10-11 16:09:54 -0400 using RuboCop version 0.26.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adroller.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    adroller (0.0.1)
+      httparty (~> 0.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    byebug (3.4.0)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.8.9)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.4.0)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adroller!
+  bundler (~> 1.7)
+  byebug (~> 3.4, >= 3.4.0)
+  factory_girl (~> 4.4, >= 4.4.0)
+  rake (~> 10.0)
+  rspec (~> 3.0, >= 3.0.0)
+  webmock (~> 1.18, >= 1.18.0)

data/README.md

@@ -0,0 +1,72 @@
+# Adroller: An API Wrapper for AdRoll
+========
+
+![alt tag](https://upload.wikimedia.org/wikipedia/commons/8/86/AdRoll.png)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adroller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adroller
+
+## Usage
+
+General Info
+============
+
+API version: v1
+
+API base url: https://api.adroll.com/v1/
+
+API documentation: https://app.adroll.com/api/v1/docs
+
+Setup
+=====
+
+Set your API username, password and organization eid in your environment
+
+ENV['ADROLL_USERNAME'] = 'Your User Name'
+
+ENV['ADROLL_PASSWORD'] = 'Your Password'
+
+ENV['ADROLL_ORGANIZATION'] = 'Your Organization eid'
+
+Method Calls
+============
+
+This gem uses basic abstraction for the AdRoll services
+
+A method call will return a JSON response directly from the api
+
+AdRoll::Api::{Endpoint Name}.{Endpoint Method}({Endpoint Parameters})
+
+Example
+=========
+params = {
+
+    name: 'My Advertisable',
+
+    organization: 'FDS32DFA3DK341B4KAL4RK',
+
+    set_as_default: true,
+
+    url: 'http://www.thisisaurl.com',
+
+    product_name: 'My Product'
+
+  }
+
+advertisable = AdRoll::Api::Advertisable.create(params)
+
+  => {:name => 'My Advertisable' ... }

data/lib/adroll/ad.rb

@@ -0,0 +1,64 @@
+require 'adroll/service'
+
+module AdRoll
+  module Api
+    class Ad < AdRoll::Api::Service
+      class << self
+        def clone(destination_url: nil, name: nil, headline: nil, body: nil)
+          params = {
+            destination_url: destination_url,
+            name: name,
+            headline: headline,
+            body: body
+          }.reject { |_, value| value.nil? }
+
+          call_api(:post, __method__, params)
+        end
+
+        def create(advertisable:, file:, destination_url: nil, name: nil,
+                   headline: nil, body: nil, message: nil, product: nil, logo: nil)
+          params = {
+            advertisable: advertisable,
+            file: file,
+            destination_url: destination_url,
+            name: name,
+            headline: headline,
+            body: body,
+            product: product,
+            logo: logo
+          }.reject { |_, value| value.nil? }
+
+          call_api(:post, __method__, params)
+        end
+
+        def edit(ad:, destination_url: nil, name: nil, headline: nil, body: nil)
+          params = {
+            ad: ad,
+            destination_url: destination_url,
+            name: name,
+            headline: headline,
+            body: body
+          }.reject { |_, value| value.nil? }
+
+          call_api(:put, __method__, params)
+        end
+
+        def get(ad:)
+          params = {
+            ad: ad
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def set_outline(ad:)
+          params = {
+            ad: ad
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+      end
+    end
+  end
+end

data/lib/adroll/adgroup.rb

@@ -0,0 +1,249 @@
+require 'adroll/service'
+
+module AdRoll
+  module Api
+    class Adgroup < AdRoll::Api::Service
+      class << self
+        def add_demographic_target(adgroup:, target_min:, min_age:, target_max:, max_age:)
+          params = {
+            adgroup: adgroup,
+            target_min: target_min,
+            min_age: min_age,
+            target_max: target_max,
+            max_age: max_age
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def add_placement_target(adgroup:, placement:)
+          params = {
+            adgroup: adgroup,
+            placement: placement
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def add_platform_target(adgroup:, type:, os:, os_version:, device:)
+          params = {
+            adgroup: adgroup,
+            type: type,
+            os: os,
+            os_version: os_version,
+            device: device
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def add_segments(adgroup:, segments:, is_negative: nil)
+          params = {
+            adgroup: adgroup,
+            segments: segments,
+            is_negative: is_negative
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def allow_site(ad_format:, site:)
+          params = {
+            ad_format: ad_format,
+            site: site
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def approve_ad(adgroup:, ad:)
+          params = {
+            adgroup: adgroup,
+            ad: ad
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def clone(adgroup:)
+          params = {
+            adgroup: adgroup
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def create(campaign:, name: nil, ads: nil, positive_segments: nil, negative_segments: nil,
+                   geo_targets:, geo_targets_countries: nil, geo_targets_regions:)
+          params = {
+            campaign: campaign,
+            name: name,
+            ads: ads,
+            positive_segments: positive_segments,
+            negative_segments: negative_segments,
+            geo_targets: geo_targets,
+            geo_targets_countries: geo_targets_countries,
+            geo_targets_regions: geo_targets_regions
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def deselect_ads(adgroup:, ads:)
+          params = {
+            adgroup: adgroup,
+            ads: ads
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def edit(campaign:, name: nil, status: nil, ads: nil, positive_segments: nil, negative_segments: nil,
+                 geo_targets:, geo_targets_countries: nil, geo_targets_regions:)
+          params = {
+            campaign: campaign,
+            name: name,
+            status: status,
+            ads: ads,
+            positive_segments: positive_segments,
+            negative_segments: negative_segments,
+            geo_targets: geo_targets,
+            geo_targets_countries: geo_targets_countries,
+            geo_targets_regions: geo_targets_regions
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def exclude_site(ad_format:, site:)
+          params = {
+            ad_format: ad_format,
+            site: site
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get(adgroup:)
+          params = {
+            adgroup: adgroup
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_ads(adgroup:, is_active: nil, statuses: nil, types: nil, width: nil, height: nil)
+          params = {
+            adgroup: adgroup,
+            is_active: is_active,
+            statuses: statuses,
+            types: types,
+            width: width,
+            height: height
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_geo_targets(adgroup:)
+          params = {
+            agroup: adgroup
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def pause(adgroup:)
+          params = {
+            adgroup: adgroup
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def pause_ad(adgroup:, ad:)
+          params = {
+            adgroup: adgroup,
+            ad: ad
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def pause_ads(adgroup:, ads:)
+          params = {
+            adgroup: adgroup,
+            ads: ads
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def remove_placement_target(adgroup:, placement:)
+          params = {
+            adgroup: adgroup,
+            placement: placement
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def remove_platform_target(adgroup:, type:, os:, os_version:, device:)
+          params = {
+            adgroup: adgroup,
+            type: type,
+            os: os,
+            os_version: os_version,
+            device: device
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def remove_segments(adgroup:, segments:)
+          params = {
+            adgroup: adgroup,
+            segments: segments
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def select_ads(adgroup:, ads:)
+          params = {
+            adgroup: adgroup,
+            ads: ads
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def unpause(adgroup:)
+          params = {
+            adgroup: adgroup
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def unpause_ad(adgroup:, ad:)
+          params = {
+            adgroup: adgroup,
+            ad: ad
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def unpause_ads(adgroup:, ads:)
+          params = {
+            adgroup: adgroup,
+            ads: ads
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+      end
+    end
+  end
+end

data/lib/adroll/advertisable.rb

@@ -0,0 +1,120 @@
+module AdRoll
+  module Api
+    class Advertisable < AdRoll::Api::Service
+      class << self
+        def create(name: nil, organization:, set_as_default: false, url: nil, product_name: nil)
+          params = {
+            name: name,
+            organization: organization,
+            set_as_default: set_as_default,
+            url: url,
+            product_name: product_name
+          }.reject { |_, value| value.nil? }
+
+          call_api(:post, __method__, params)
+        end
+
+        def edit(advertisable:, click_through_conversion_window: nil, name: nil, path_name: nil,
+                 url: nil, product_name: nil, view_through_conversion_window: nil)
+
+          params = {
+            advertisable: advertisable,
+            click_through_conversion_window: click_through_conversion_window,
+            name: name,
+            path_name: path_name,
+            url: url,
+            product_name: product_name,
+            view_through_conversion_window: view_through_conversion_window
+          }.reject { |_, value| value.nil? }
+
+          call_api(:put, __method__, params)
+        end
+
+        def enable_rollcrawl(advertisable:, url:)
+          params = {
+            advertisable: advertisable,
+            url: url
+          }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get(advertisable:)
+          params = {
+            advertisable: advertisable
+          }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_adgroups(advertisable:, camp_active: true, camp_statuses: nil, camp_blacklist_statuses: nil,
+                         camp_type: nil, statuses: %w(approved admin_review paused admin_paused),
+                         blacklist_statuses: nil)
+
+          params = {
+            advertisable: advertisable,
+            camp_active: camp_active,
+            camp_statuses: camp_statuses,
+            camp_blacklist_statuses: camp_blacklist_statuses,
+            camp_type: camp_type,
+            statuses: statuses,
+            blacklist_statuses: blacklist_statuses
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_ads(advertisable:, is_active: true, statuses: nil, types: nil, width: nil, height: nil)
+          params = {
+            advertisable: advertisable,
+            is_active: is_active,
+            statuses: statuses,
+            types: types,
+            width: width,
+            height: height
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_campaigns(advertisable:, is_active: true, statuses: nil, types: nil, blacklist_statuses: nil)
+          params = {
+            advertisable: advertisable,
+            is_active: is_active,
+            statuses: statuses,
+            blacklist_statues: blacklist_statuses,
+            types: types
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_coops(advertisable:, filter_active:, coops_active: true)
+          params = {
+            advertisable: advertisable,
+            filter_active: filter_active,
+            coops_active: coops_active
+          }.reject { |_, value| value.nil? }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_pixel(advertisable:)
+          params = {
+            advertisable: advertisable
+          }
+
+          call_api(:get, __method__, params)
+        end
+
+        def get_segments(advertisable:)
+          params = {
+            advertisable: advertisable
+          }
+
+          call_api(:get, __method__, params)
+        end
+      end
+    end
+  end
+end