perfecta 0.1.2 → 0.2.0

data/README.md

@@ -39,23 +39,105 @@ You can now use the client instance to query the API.
 p client.campaign_reports.inspect
 ```
 
+Optional Query Parameters include
+
+| Name          | Type                                                          |
+| ------------- |:-------------------------------------------------------------:|
+| interval      | ['today','yesterday','last_7_days','last_30_days','lifetime'] |
+| start_date    | 'YYYY-MM-DD'                                                  |
+| end_date      | 'YYYY-MM-DD'                                                  |
+| site_id       | 'the_site_id'                                                 |
+| campaign_id   | 'the_site_id'                                                 |
+
+and can be used by supplying a hash e.g.
+
+```ruby
+p client.campaign_reports(interval: 'yesterday').inspect
+```
+
 ### List all Ad Reports
 
 ```ruby
 p client.ad_reports.inspect
 ```
 
+Any of the additional query parameters from the above table can be supplied as a hash.
+
 ### List all Conversion Reports
 
 ```ruby
 p client.conversion_reports.inspect
 ```
 
+Any of the additional query parameters from the above table can be supplied as a hash.
+
+### List all Sites
+
+```ruby
+p client.sites.inspect
+```
+
+### Show a single Site
+
+```ruby
+p client.site('SITE_ID').inspect
+```
+
+### List all Campaigns
+
+```ruby
+p client.campaigns.inspect
+```
+
+### Show a single Campaign
+
+```ruby
+p client.campaign('CAMPAIGN_ID').inspect
+```
+
+### List all Ads
+
+```ruby
+p client.ads.inspect
+```
+
+### Show a single Ad
+
+```ruby
+p client.ad('AD_ID').inspect
+```
+
+### List all Segments
+
+```ruby
+p client.segments.inspect
+```
+
+### Show a single Segment
+
+```ruby
+p client.segment('SEGMENT_ID').inspect
+```
+
+### List all Conversions
+
+```ruby
+p client.conversions.inspect
+```
+
+### Show a single Conversion
+
+```ruby
+p client.conversion('CONVERSION_ID').inspect
+```
+
 ## TODO
 
-1. Flesh out the rest of the API
-2. Error handling, specifically for when token expires
-3. Relationships and delegation between of objects
+1. ~~Flesh out the rest of the API~~
+2. ~~Accept query parameters~~
+3. Error handling, specifically for when token expires
+4. Relationships and delegation between of objects
+5. ~~Get rid of all the duplication~~
 
 ## Contributing
 

data/lib/perfecta/ad.rb

@@ -0,0 +1,7 @@
+module Perfecta
+  class Ad < ApiResource
+    def initialize attrs
+      super attrs
+    end
+  end
+end

data/lib/perfecta/campaign.rb

@@ -0,0 +1,7 @@
+module Perfecta
+  class Campaign < ApiResource
+    def initialize attrs
+      super attrs
+    end
+  end
+end

data/lib/perfecta/conversion.rb

@@ -0,0 +1,7 @@
+module Perfecta
+  class Conversion < ApiResource
+    def initialize attrs
+      super attrs
+    end
+  end
+end

data/lib/perfecta/segment.rb

@@ -0,0 +1,7 @@
+module Perfecta
+  class Segment < ApiResource
+    def initialize attrs
+      super attrs
+    end
+  end
+end

data/lib/perfecta/site.rb

@@ -0,0 +1,7 @@
+module Perfecta
+  class Site < ApiResource
+    def initialize attrs
+      super attrs
+    end
+  end
+end

data/lib/perfecta/version.rb

@@ -1,3 +1,3 @@
 module Perfecta
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/perfecta.rb

@@ -3,14 +3,28 @@ require "perfecta/api_resource"
 require "perfecta/campaign_report"
 require "perfecta/ad_report"
 require "perfecta/conversion_report"
+require "perfecta/site"
+require "perfecta/campaign"
+require "perfecta/ad"
+require "perfecta/conversion"
+require "perfecta/segment"
 require "rest-client"
 require "json"
+require "active_support/inflector"
 
 module Perfecta
   class Client
 
     BASE_API_PATH = 'https://api.perfectaudience.com'
 
+    ALLOWED_REPORT_PARAMS = [
+      :interval,
+      :start_date,
+      :end_date,
+      :site_id,
+      :campaign_id
+    ].freeze
+
     attr_accessor :email, :password, :token
 
     def initialize &block
@@ -18,28 +32,71 @@ module Perfecta
       @token = exchange_credentials_for_token
     end
 
-    def campaign_reports
-      url = "#{BASE_API_PATH}/reports/campaign_report"
-      resp =  JSON.parse(RestClient.get(url, {Authorization: @token}))
+    def campaign_reports params = {}
+      url, params = build_report_url_and_params_for('campaign', params)
+
+      resp =  JSON.parse(RestClient.get(url, params))
+
+      build_collection_of 'CampaignReport', resp
+    end
+
+    def ad_reports params = {}
+      url, params = build_report_url_and_params_for('ad', params)
+
+      resp =  JSON.parse(RestClient.get(url, params))
+
+      build_collection_of 'AdReport', resp
+    end
+
+    def conversion_reports params = {}
+      url, params = build_report_url_and_params_for('conversion', params)
+
+      resp =  JSON.parse(RestClient.get(url, params))
+
+      build_collection_of 'ConversionReport', resp
+    end
+
+    def sites
+      get_many 'sites'
+    end
+
+    def site id
+      get_one 'site', id
+    end
+
+    def campaigns
+      get_many 'campaigns'
+    end
+
+    def campaign id
+      get_one 'campaign', id
+    end
+
+    def ads
+      get_many 'ads'
+    end
 
-      build_collection_of 'CampaignReport', resp['report']
+    def ad id
+      get_one 'ad', id
     end
 
-    def ad_reports
-      url = "#{BASE_API_PATH}/reports/ad_report"
-      resp =  JSON.parse(RestClient.get(url, {Authorization: @token}))
+    def conversions
+      get_many 'conversions'
+    end
 
-      build_collection_of 'AdReport', resp['report']
+    def conversion id
+      get_one 'conversion', id
     end
 
-    def conversion_reports
-      url = "#{BASE_API_PATH}/reports/conversion_report"
-      resp =  JSON.parse(RestClient.get(url, {Authorization: @token}))
+    def segments
+      get_many 'segments'
+    end
 
-      build_collection_of 'ConversionReport', resp['report']
+    def segment id
+      get_one 'segment', id
     end
 
-    private 
+    private
 
     def exchange_credentials_for_token
       authenticate
@@ -61,12 +118,56 @@ module Perfecta
     def build_collection_of klass, data
       retval = []
 
-      data.each do |d|
+      raise BadResponse unless data['status'] == 200
+
+      data['report'].each do |d|
         obj = Perfecta.const_get(klass.to_sym).new d
         retval << obj
       end
 
       retval
     end
+
+    def get_one type, id
+      url = "#{BASE_API_PATH}/#{type.pluralize}/#{id}"
+
+      resp = JSON.parse(RestClient.get(url, Authorization: @token))
+
+      klass_name = type.capitalize
+      klass = Perfecta.const_get(klass_name.to_sym)
+
+      obj = klass.new resp[type]
+
+      obj
+    end
+
+    def get_many type
+      url = "#{BASE_API_PATH}/#{type}"
+
+      resp = JSON.parse(RestClient.get(url, Authorization: @token))
+
+      klass_name = type.capitalize.singularize
+      klass = Perfecta.const_get(klass_name.to_sym)
+
+      retval = []
+
+      resp[type].each do |obj|
+        retval << klass.new(obj)
+      end
+
+      retval
+    end
+
+    def build_report_url_and_params_for type, params
+      url = "#{BASE_API_PATH}/reports/#{type}_report"
+
+      params.keep_if {|p| ALLOWED_REPORT_PARAMS.include? p}
+
+      params = {params: params}.merge! Authorization: @token
+
+      [url, params]
+    end
   end
+
+  class BadResponse < Exception; end
 end

data/perfecta.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "rest-client"
+  gem.add_dependency "activesupport"
   gem.add_development_dependency "mocha"
 end

data/test/campaign_test.rb

@@ -0,0 +1,20 @@
+require_relative 'test_helper'
+
+class CampaignTest < MiniTest::Unit::TestCase
+
+  describe 'Campaign' do
+
+    before do
+      @attrs = {name: 'Campaign 1'}
+      @report = Perfecta::Campaign.new @attrs
+    end
+
+    it 'should be created from a hash' do
+      @report.must_be_instance_of Perfecta::Campaign
+    end
+
+    it 'should set the values for each property' do
+      @report.name.must_equal 'Campaign 1'
+    end
+  end
+end

data/test/site_test.rb

@@ -0,0 +1,20 @@
+require_relative 'test_helper'
+
+class SiteTest < MiniTest::Unit::TestCase
+
+  describe 'Site' do
+
+    before do
+      @attrs = {name: 'Site 1'}
+      @report = Perfecta::Site.new @attrs
+    end
+
+    it 'should be created from a hash' do
+      @report.must_be_instance_of Perfecta::Site
+    end
+
+    it 'should set the values for each property' do
+      @report.name.must_equal 'Site 1'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfecta
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +72,23 @@ files:
 - README.md
 - Rakefile
 - lib/perfecta.rb
+- lib/perfecta/ad.rb
 - lib/perfecta/ad_report.rb
 - lib/perfecta/api_resource.rb
+- lib/perfecta/campaign.rb
 - lib/perfecta/campaign_report.rb
+- lib/perfecta/conversion.rb
 - lib/perfecta/conversion_report.rb
+- lib/perfecta/segment.rb
+- lib/perfecta/site.rb
 - lib/perfecta/version.rb
 - perfecta.gemspec
 - test/ad_report_test.rb
 - test/campaign_report_test.rb
+- test/campaign_test.rb
 - test/conversion_report_test.rb
 - test/perfecta_test.rb
+- test/site_test.rb
 - test/test_helper.rb
 homepage: https://github.com/gary-rafferty/perfecta
 licenses: []
@@ -94,6 +117,8 @@ summary: Ruby client for the PerfectAudience Reporting API
 test_files:
 - test/ad_report_test.rb
 - test/campaign_report_test.rb
+- test/campaign_test.rb
 - test/conversion_report_test.rb
 - test/perfecta_test.rb
+- test/site_test.rb
 - test/test_helper.rb