perfecta 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8bc2ccc98888f9c26d9a750b41dacf938df86e1
-  data.tar.gz: cbca3c664ff86f7c070da5f3cef9d362502f15ab
+  metadata.gz: 46ddcaccb8c6c33dbf919009621b431d3cbd9df7
+  data.tar.gz: 36f0ecbd458731641ff6161fd53403d5eacd79e0
 SHA512:
-  metadata.gz: 994bee046cc159f924d1ee3d67ec328c28284b3fe0472d4496bafa34804abdd35002a5eae2f08067446f2b2c8cae2574be094ffb574de148bde31eb288f71dba
-  data.tar.gz: 34c0eaa6454f20c84978e69b7c6fb420b5d5019c2d26d15ba29f5c6662ddd00d81fe29f38aaade5c13113c4f23906cf31f4e3bbb5bfba476c01bbba2f9794727
+  metadata.gz: acde9279ce53006f813da63a8dc86342c200cac4d727b1afdcf2fd78d9d14dc1403f12d6d87d3bec0c418727c4df99c9131492719d6cbcd3779fe03feef6d4ec
+  data.tar.gz: f87634944a373b41dc12e4527dad78e894a5ffd65444d3bf0fa02b15a5e10a711e084e2c486f5e371ddd7fcdafe41a4bc3c2378036bebf17db47215c308ad37c

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.3"
-  - "2.0.0"
+  - "2.1"
+  - "2.2"
+  - "2.3"

data/README.md

@@ -5,7 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/gary-rafferty/perfecta.png)](https://codeclimate.com/github/gary-rafferty/perfecta)
 
 Ruby client for the Perfect Audience [reporting
-api](https://www.perfectaudience.com/docs#data_api_autoopen)
+api](http://support.perfectaudience.com/knowledgebase/articles/233919-reporting-api)
 
 ## Installation
 

data/lib/perfecta/version.rb

@@ -1,3 +1,3 @@
 module Perfecta
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/perfecta.rb

@@ -35,7 +35,7 @@ module Perfecta
     def campaign_reports params = {}
       url, params = build_report_url_and_params_for('campaign', params)
 
-      resp =  JSON.parse(RestClient.get(url, params))
+      resp =  make_request url, params
 
       build_collection_of 'CampaignReport', resp
     end
@@ -43,7 +43,7 @@ module Perfecta
     def ad_reports params = {}
       url, params = build_report_url_and_params_for('ad', params)
 
-      resp =  JSON.parse(RestClient.get(url, params))
+      resp =  make_request url, params
 
       build_collection_of 'AdReport', resp
     end
@@ -51,7 +51,7 @@ module Perfecta
     def conversion_reports params = {}
       url, params = build_report_url_and_params_for('conversion', params)
 
-      resp =  JSON.parse(RestClient.get(url, params))
+      resp =  make_request url, params
 
       build_collection_of 'ConversionReport', resp
     end
@@ -116,22 +116,17 @@ module Perfecta
     end
 
     def build_collection_of klass, data
-      retval = []
-
       raise BadResponse unless data['status'] == 200
 
-      data['report'].each do |d|
-        obj = Perfecta.const_get(klass.to_sym).new d
-        retval << obj
+      data['report'].map do |d|
+        Perfecta.const_get(klass.to_sym).new d
       end
-
-      retval
     end
 
     def get_one type, id
       url = "#{BASE_API_PATH}/#{type.pluralize}/#{id}"
 
-      resp = JSON.parse(RestClient.get(url, "Authorization".to_sym => @token))
+      resp = make_request url, "Authorization".to_sym => @token
 
       klass_name = type.capitalize
       klass = Perfecta.const_get(klass_name.to_sym)
@@ -144,18 +139,14 @@ module Perfecta
     def get_many type
       url = "#{BASE_API_PATH}/#{type}"
 
-      resp = JSON.parse(RestClient.get(url, "Authorization".to_sym => @token))
+      resp = make_request url, "Authorization".to_sym => @token
 
       klass_name = type.capitalize.singularize
       klass = Perfecta.const_get(klass_name.to_sym)
 
-      retval = []
-
-      resp[type].each do |obj|
-        retval << klass.new(obj)
+      resp[type].map do |obj|
+        klass.new(obj)
       end
-
-      retval
     end
 
     def build_report_url_and_params_for type, params
@@ -167,6 +158,10 @@ module Perfecta
 
       [url, params]
     end
+
+    def make_request url, params = nil
+      JSON.parse(RestClient.get(url, params))
+    end
   end
 
   class BadResponse < Exception; end

data/test/perfecta_test.rb

@@ -26,5 +26,171 @@ class PerfectaTest < Minitest::Test
       @client.token.wont_be_nil
       @client.token.must_equal 'token'
     end
+
+    it "can retrieve and return campaign_reports" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'report' => [{
+          'campaign_id' => '5074bc89d7a67f0002000026',
+          'campaign_name' => 'My campaign',
+          'impressions' => 25000,
+          'clicks' => 750,
+          'costs' => 25.2,
+          'click_conversions' => 10,
+          'view_conversions' => 20,
+          'conversions' => 30,
+          'cpm' => 1.008,
+          'ctr' =>  0.03,
+          'cpc' => 0.0336,
+          'conversion_rate' => 0.04
+        }]
+      })
+
+      campaign_report = @client.campaign_reports.first
+      campaign_report.must_be_instance_of Perfecta::CampaignReport
+      campaign_report.impressions.must_equal 25000
+    end
+
+    it "can retrieve and return ad_reports" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'report' => [{
+          'ad_id' => '5074bc89d7a67f0002000026',
+          'ad_name' => 'My ad',
+          'impressions' => 25000,
+          'clicks' => 750,
+          'costs' => 25.2,
+          'click_conversions' => 10,
+          'view_conversions' => 20,
+          'conversions' => 30,
+          'cpm' => 1.008,
+          'ctr' =>  0.03,
+          'cpc' => 0.0336,
+          'conversion_rate' => 0.04
+        }]
+      })
+
+      ad_report = @client.ad_reports.first
+      ad_report.must_be_instance_of Perfecta::AdReport
+      ad_report.impressions.must_equal 25000
+    end
+
+    it "can retrieve and return conversion_reports" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'report' => [{
+          'conversion_id' => '5074bc89d7a67f0002000026',
+          'conversion_name' => 'Sale',
+          'click_conversions' => 10,
+          'view_conversions' => 20,
+          'conversions' => 30,
+        }]
+      })
+
+      conversion_report = @client.conversion_reports.first
+      conversion_report.must_be_instance_of Perfecta::ConversionReport
+      conversion_report.conversions.must_equal 30
+    end
+
+    it "can retrieve and return site objects" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'sites' => [{
+          '_id' => '5074bc89d7a67f0002000026',
+          'name' => 'My Site',
+          'url' => 'https://www.perfectaudience.com',
+          'created_at' => '2013-01-11T16:38:32+00:00',
+          'view_conversion_window' => 30,
+          'click_conversion_window' => 30,
+          'domain_blacklist' => 'http://blacklist.com,http://donotserve.com'
+        }]
+      })
+
+      site_obj = @client.sites.first
+      site_obj.must_be_instance_of Perfecta::Site
+      site_obj.name.must_equal 'My Site'
+    end
+
+    it "can retrieve and return campaign objects" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'campaigns' => [{
+          '_id' => '5074bc89d7a67f0002000026',
+          'site_id' => '4ff6ade4361ed500020111a5',
+          'name' => 'My Campaign',
+          'created_at' => '2013-01-11T16:38:32+00:00',
+          'state' => 'active',
+          'start_date' => '2012-12-18T00:00:00+00:00',
+          'end_date' => '2013-03-18T00:00:00+00:00',
+          'cpm_max_bid' => 0.5,
+          'weekly_budget' => 500
+        }]
+      })
+
+      campaign_obj = @client.campaigns.first
+      campaign_obj.must_be_instance_of Perfecta::Campaign
+      campaign_obj.weekly_budget.must_equal 500
+    end
+
+    it "can retrieve and return ad objects" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'ads' => [{
+          '_id' => '5074bc89d7a67f0002000026',
+          'site_id' => '4ff6ade4361ed500020111a5',
+          'name' => 'My ad',
+          'state' => 'active',
+          'click_url' => 'https://www.perfectaudience.com',
+          'created_at' => '2013-01-11T16:38:32+00:00',
+          'dimensions' => '99x72',
+          'type' => 'facebook',
+          'facebook_title' => 'title',
+          'facebook_body' => 'body'
+        }]
+      })
+
+      ad_obj = @client.ads.first
+      ad_obj.must_be_instance_of Perfecta::Ad
+      ad_obj.type.must_equal 'facebook'
+    end
+
+    it "can retrieve and return segment objects" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'segments' => [{
+          '_id' => '5074bc89d7a67f0002000026',
+          'site_id' => '4ff6ade4361ed500020111a5',
+          'name' => 'My Segment',
+          'created_at' => '2013-01-11T16:38:32+00:00',
+          'duration' => 45,
+          'goal' => 'path',
+          'target_text' => '/trial*'
+        }]
+      })
+
+      segment_obj = @client.segments.first
+      segment_obj.must_be_instance_of Perfecta::Segment
+      segment_obj.duration.must_equal 45
+    end
+
+    it "can retrieve and return conversion objects" do
+      @client.stubs(:make_request).returns({
+        'status' => 200,
+        'conversions' => [{
+          '_id' => '5074bc89d7a67f0002000026',
+          'site_id' => '4ff6ade4361ed500020111a5',
+          'name' => 'Signup',
+          'created_at' => '2013-01-11T16:38:32+00:00',
+          'conversion_frequency' => 'every',
+          'last_fired' => '2013-03-19T21:29:02+00:00',
+          'goal' => 'path',
+          'target_text' => '/orderSuccess'
+        }]
+      })
+
+      conv_obj = @client.conversions.first
+      conv_obj.must_be_instance_of Perfecta::Conversion
+      conv_obj.goal.must_equal 'path'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfecta
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Gary Rafferty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2016-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the PerfectAudience Reporting API
@@ -158,4 +159,3 @@ test_files:
 - test/perfecta_test.rb
 - test/site_test.rb
 - test/test_helper.rb
-has_rdoc: