perfecta 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gary Rafferty
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Perfecta
+
+Ruby client for the Perfect Audience [reporting
+api](https://www.perfectaudience.com/docs#data_api_autoopen)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'perfecta'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install perfecta
+
+## Usage
+
+### Create a new instance of the Perfecta Client
+
+```ruby
+client = Perfecta::Client.new do |c|
+  c.email = 'email@ddress'
+  c.password = 'password'
+end
+```
+
+This will exchange the credentials for an API token and use this token
+for all subsequent calls.
+
+You can now use the client instance to query the API.
+
+### List all Campaign Reports
+
+```ruby
+p client.campaign_reports.inspect
+```
+
+### List all Ad Reports
+
+```ruby
+p client.ad_reports.inspect
+```
+
+### List all Conversion Reports
+
+```ruby
+p client.conversion_reports.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
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/perfecta/ad_report.rb

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

data/lib/perfecta/api_resource.rb

@@ -0,0 +1,13 @@
+module Perfecta
+  class ApiResource
+    def initialize attrs
+      attrs.each do |name, val|
+        instance_variable_set "@#{name}", val
+
+        define_singleton_method name.to_sym do
+          instance_variable_get "@#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/perfecta/campaign_report.rb

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

data/lib/perfecta/conversion_report.rb

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

data/lib/perfecta/version.rb

@@ -0,0 +1,3 @@
+module Perfecta
+  VERSION = "0.1.0"
+end

data/lib/perfecta.rb

@@ -0,0 +1,72 @@
+require "perfecta/version"
+require "perfecta/api_resource"
+require "perfecta/campaign_report"
+require "perfecta/ad_report"
+require "perfecta/conversion_report"
+require "rest-client"
+require "json"
+
+module Perfecta
+  class Client
+
+    BASE_API_PATH = 'https://api.perfectaudience.com'
+
+    attr_accessor :email, :password, :token
+
+    def initialize &block
+      yield self if block_given?
+      @token = exchange_credentials_for_token
+    end
+
+    def campaign_reports
+      url = "#{BASE_API_PATH}/reports/campaign_report"
+      resp =  JSON.parse(RestClient.get(url, {Authorization: @token}))
+
+      build_collection_of 'CampaignReport', resp['report']
+    end
+
+    def ad_reports
+      url = "#{BASE_API_PATH}/reports/ad_report"
+      resp =  JSON.parse(RestClient.get(url, {Authorization: @token}))
+
+      build_collection_of 'AdReport', resp['report']
+    end
+
+    def conversion_reports
+      url = "#{BASE_API_PATH}/reports/conversion_report"
+      resp =  JSON.parse(RestClient.get(url, {Authorization: @token}))
+
+      build_collection_of 'ConversionReport', resp['report']
+    end
+
+    private 
+
+    def exchange_credentials_for_token
+      authenticate
+    end
+
+    def authenticate
+      url = "#{BASE_API_PATH}/auth"
+      data = {email: @email, password: @password}
+
+      resp = RestClient.post(url, data)
+
+      json = JSON.parse resp
+
+      if json['status'] == 200
+        json['token']
+      end
+    end
+
+    def build_collection_of klass, data
+      retval = []
+
+      data.each do |d|
+        obj = Perfecta.const_get(klass.to_sym).new d
+        retval << obj
+      end
+
+      retval
+    end
+  end
+end

data/perfecta.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perfecta/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "perfecta"
+  gem.version       = Perfecta::VERSION
+  gem.authors       = ["Gary Rafferty"]
+  gem.email         = ["gary.rafferty@gmail.com"]
+  gem.description   = %q{Ruby API for the PerfectAudience Reporting API}
+  gem.summary       = %q{Ruby APU for the PerfectAudience Reporting API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rest-client"
+  gem.add_development_dependency "mocha"
+end

data/test/ad_report_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+
+class AdReportTest < MiniTest::Unit::TestCase
+
+  describe 'AdReport' do
+
+    before do
+      @attrs = {ad_name: 'Ad 1', ad_id: 123}
+      @report = Perfecta::AdReport.new @attrs
+    end
+
+    it 'should be created from a hash' do
+      @report.must_be_instance_of Perfecta::AdReport
+    end
+
+    it 'should set the values for each property' do
+      @report.ad_name.must_equal 'Ad 1'
+      @report.ad_id.must_equal 123
+    end
+  end
+end

data/test/campaign_report_test.rb

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

data/test/conversion_report_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+
+class ConversionReportTest < MiniTest::Unit::TestCase
+
+  describe 'ConversionReport' do
+
+    before do
+      @attrs = {conversion_name: 'Conversion 1', conversion_id: 123}
+      @report = Perfecta::ConversionReport.new @attrs
+    end
+
+    it 'should be created from a hash' do
+      @report.must_be_instance_of Perfecta::ConversionReport
+    end
+
+    it 'should set the values for each property' do
+      @report.conversion_name.must_equal 'Conversion 1'
+      @report.conversion_id.must_equal 123
+    end
+  end
+end

data/test/perfecta_test.rb

@@ -0,0 +1,33 @@
+require_relative 'test_helper'
+
+class PerfectaTest < MiniTest::Unit::TestCase
+
+  describe 'Perfecta client' do
+
+    before do
+      Perfecta::Client
+        .any_instance
+        .stubs(:exchange_credentials_for_token)
+        .returns('token')
+
+      @client = Perfecta::Client.new do |c|
+        c.email = 'email@ddress'
+        c.password = 'password'
+      end
+    end
+
+    it 'is initialized with an email and password' do
+      @client.must_be_instance_of Perfecta::Client
+    end
+
+    it "sets the email and password vars" do
+      @client.email.must_equal 'email@ddress'
+      @client.password.must_equal 'password'
+    end
+
+    it "should authenticate and set the token" do
+      @client.token.wont_be_nil
+      @client.token.must_equal 'token'
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.join(File.dirname(__FILE__),'..','lib'))
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'perfecta'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: perfecta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gary Rafferty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API for the PerfectAudience Reporting API
+email:
+- gary.rafferty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/perfecta.rb
+- lib/perfecta/ad_report.rb
+- lib/perfecta/api_resource.rb
+- lib/perfecta/campaign_report.rb
+- lib/perfecta/conversion_report.rb
+- lib/perfecta/version.rb
+- perfecta.gemspec
+- test/ad_report_test.rb
+- test/campaign_report_test.rb
+- test/conversion_report_test.rb
+- test/perfecta_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby APU for the PerfectAudience Reporting API
+test_files:
+- test/ad_report_test.rb
+- test/campaign_report_test.rb
+- test/conversion_report_test.rb
+- test/perfecta_test.rb
+- test/test_helper.rb