eucalyptus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f17283339eb29832b6ca29b810539783b67fbca8
-  data.tar.gz: 1eb136e165e2182ebe8db581e69b8e2868515ecd
+  metadata.gz: 485cdd5a1ab888a49685773e0de56b702817ef92
+  data.tar.gz: d18f3e3a800a663772619b8fba0c1a437bd7fb4a
 SHA512:
-  metadata.gz: 72390b8cf41162495cd09cf4bdcde01a62e53d283605f40b9d367859311894dab7033d6f5e3169e6eb5c2ed28dbb003ab853a68d10e40fd04a12e705c8241982
-  data.tar.gz: d0d7836fc079ddf6f1422e99c8032a213e915ac20da0203aab3f1e18c4430100113de8683c9eb1a1b057c926a12382c7dc3fc187d797322515be686af1693e73
+  metadata.gz: f699c5496d353681f5b8e6ae49a648f591fc5b8c357ae2791d0fa8c3a92ad42d90a235c146143157d68a8bd16a0644cadc9ed6052300c6c2bd4d58a057eabc64
+  data.tar.gz: 4a6946e771678ce08a2b542e1ebe31eeecfdbde241afe13ef39848d3b83178e2b82c0f7c94fd9796f51d2b3245fe598944743be2c8d572ccefbcbf0fc154b117

data/Gemfile

@@ -11,7 +11,6 @@ group :development do
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
   gem "jeweler", "~> 2.0.1"
-  gem "simplecov", ">= 0"
   gem "pry"
   gem 'dotenv'
   gem 'webmock'

data/Gemfile.lock

@@ -9,7 +9,6 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    docile (1.1.5)
     dotenv (2.0.1)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
@@ -74,11 +73,6 @@ GEM
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
     safe_yaml (1.0.4)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
     slop (3.6.0)
     thread_safe (0.3.5)
     vcr (2.9.2)
@@ -97,6 +91,5 @@ DEPENDENCIES
   pry
   rdoc (~> 3.12)
   rspec
-  simplecov
   vcr
   webmock

data/README.md

@@ -33,8 +33,8 @@ campaign.name
 account_ads = account.ads
 campaign_ads = campaign.ads
 
-stats = campaign.report_stats
-stats.cpa
+insights = campaign.insights
+insights.cpa
 
 ads = Add.all
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/eucalyptus.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: eucalyptus 0.1.0 ruby lib
+# stub: eucalyptus 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "eucalyptus"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Oguz Huner"]
-  s.date = "2015-06-16"
+  s.date = "2015-06-22"
   s.description = "An easy interface and abstraction to the Facebook Ads API"
   s.email = "oguzcanhuner@gmail.com"
   s.extra_rdoc_files = [
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
-    ".env",
     ".rspec",
     "Gemfile",
     "Gemfile.lock",
@@ -29,20 +28,21 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "eucalyptus.gemspec",
-    "fixtures/vcr_cassettes/account_ad_sets.yml",
-    "fixtures/vcr_cassettes/account_ads.yml",
-    "fixtures/vcr_cassettes/account_campaigns.yml",
-    "fixtures/vcr_cassettes/test2.yml",
     "lib/eucalyptus.rb",
     "lib/eucalyptus/account.rb",
     "lib/eucalyptus/ad.rb",
     "lib/eucalyptus/ad_set.rb",
     "lib/eucalyptus/campaign.rb",
     "lib/eucalyptus/custom_audience.rb",
+    "lib/eucalyptus/insight.rb",
     "lib/eucalyptus/resource.rb",
     "lib/eucalyptus/response.rb",
     "spec/eucalyptus/account_spec.rb",
+    "spec/eucalyptus/ad_set_spec.rb",
+    "spec/eucalyptus/ad_spec.rb",
+    "spec/eucalyptus/campaign_spec.rb",
     "spec/eucalyptus/custom_audience_spec.rb",
+    "spec/eucalyptus/insight_spec.rb",
     "spec/eucalyptus/resource_spec.rb",
     "spec/eucalyptus_spec.rb",
     "spec/spec_helper.rb"
@@ -62,7 +62,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<dotenv>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
@@ -73,7 +72,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<dotenv>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
@@ -85,7 +83,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<dotenv>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])

data/lib/eucalyptus/account.rb

@@ -2,18 +2,60 @@ require_relative 'resource'
 
 module Eucalyptus
   class Account < Resource
+    def self.known_fields
+      [
+        :account_status,
+        :age,
+        :agency_client_declaration,
+        :amount_spent,
+        :balance,
+        :business,
+        :business_city,
+        :business_country_code,
+        :business_name,
+        :business_street,
+        :business_street2,
+        :business_zip,
+        :capabilities,
+        :created_time,
+        :currency,
+        :daily_spend_limit,
+        :end_advertiser,
+        :funding_source,
+        :funding_source_details,
+        :is_personal,
+        :media_agency,
+        :name,
+        :offsite_pixels_tos_accepted,
+        :partner,
+        :rf_spec,
+        :spend_cap,
+        :tax_id_status,
+        :timezone_id,
+        :timezone_name,
+        :timezone_offset_hours_utc,
+        :tos_accepted,
+        :users
+      ]
+    end
+
     def self.api_path
       "adaccounts"
     end
 
+
     # 'me' is a facebook helper which refers to the user who created the access token
+    #
+    # there is no object which abstracts this, which is why we're using a generic 
+    # open struct that can response to id
     def self.parent
       OpenStruct.new(id: "me")
     end
 
-    # associations
+    # ASSOCIATOINS
     def ads; Ad.all(parent: self); end
     def ad_sets; AdSet.all(parent: self); end
     def campaigns; Campaign.all(parent: self); end
+    def insights; Insight.all(parent: self); end
   end
 end

data/lib/eucalyptus/ad.rb

@@ -2,6 +2,25 @@ require_relative 'resource'
 
 module Eucalyptus
   class Ad < Resource
+    def self.known_fields
+      [
+        :name,
+        :adgroup_status,
+        :bid_info,
+        :conversion_specs,
+        :campaign_id,
+        :creative,
+        :engagement_audiences,
+        :execution_options,
+        :redownload,
+        :tracking_specs,
+        :social_prefs
+      ]
+    end
+
+    def ad_set; AdSet.find(self.campaign_id); end
+    def insights; Insight.all(parent: self); end
+
     def self.api_path
       "adgroups"
     end

data/lib/eucalyptus/ad_set.rb

@@ -2,6 +2,32 @@ require_relative 'resource'
 
 module Eucalyptus
   class AdSet < Resource
+    def self.known_fields
+      [
+        :account_id,
+        :bid_info,
+        :bid_type,
+        :campaign_group_id,
+        :campaign_status,
+        :created_time,
+        :creative_sequence,
+        :daily_budget,
+        :end_time,
+        :is_autobid,
+        :lifetime_budget,
+        :name,
+        :promoted_object,
+        :rf_prediction_id,
+        :start_time,
+        :targeting,
+        :updated_time
+      ]
+    end
+
+    def campaign; Campaign.find(self.campaign_group_id); end
+    def ads; Ad.all(parent: self); end
+    def insights; Insight.all(parent: self); end
+
     def self.api_path
       "adcampaigns"
     end

data/lib/eucalyptus/campaign.rb

@@ -2,8 +2,22 @@ require_relative 'resource'
 
 module Eucalyptus
   class Campaign < Resource
+    def self.known_fields
+      [
+        :buying_type,
+        :campaign_group_status,
+        :name,
+        :objective,
+        :spend_cap
+      ]
+    end
+
     def self.api_path
       "adcampaign_groups"
     end
+
+    def ads; Ad.all(parent: self); end
+    def ad_sets; AdSet.all(parent: self); end
+    def insights; Insight.all(parent: self); end
   end
 end

data/lib/eucalyptus/custom_audience.rb

@@ -5,5 +5,9 @@ module Eucalyptus
     def self.api_path
       "customaudiences"
     end
+
+    def self.known_fields
+      [:name, :description]
+    end
   end
 end

data/lib/eucalyptus/insight.rb

@@ -0,0 +1,43 @@
+require_relative 'resource'
+
+module Eucalyptus
+  class Insight < Resource
+    def self.known_fields
+      [
+        :actions_per_impression,
+        :call_to_action_clicks,
+        :clicks,
+        :unique_clicks,
+        :cost_per_total_action,
+        :cpc,
+        :cost_per_unique_click,
+        :cpm,
+        :cpp,
+        :ctr,
+        :website_ctr,
+        :unique_ctr,
+        :frequency,
+        :impressions,
+        :reach,
+        :relevance_score,
+        :roas,
+        :social_clicks,
+        :unique_social_clicks,
+        :social_impressions,
+        :social_reach,
+        :spend,
+        :total_action_value,
+        :total_actions,
+        :total_unique_actions
+      ]
+    end
+
+    def self.find
+      raise "An insight can only be used as part of a combined call. Try Insight.all"
+    end
+
+    def self.api_path
+      'insights'
+    end
+  end
+end

data/lib/eucalyptus/resource.rb

@@ -1,20 +1,28 @@
 module Eucalyptus
   class Resource
     def self.api_path
-      raise "You must implement this method"
+      raise "You must implement #{__method__.to_s}"
+    end
+
+    def self.known_fields
+      raise "You must implement #{__method__.to_s}"
     end
 
     def self.parent
       Account.all.last
     end
 
-    def self.find(id, graph: Eucalyptus.graph)
-      response = graph.get_object(id)
+    def self.find(id, fields: [], graph: Eucalyptus.graph)
+      fields.concat(self.known_fields).uniq
+
+      response = graph.get_object(id, fields: fields)
       self.new(response)
     end
 
-    def self.all(graph: Eucalyptus.graph, parent: self.parent)
-      response = graph.get_connection(parent.id, api_path)
+    def self.all(graph: Eucalyptus.graph, parent: self.parent, fields: [])
+      fields.concat(self.known_fields).uniq
+
+      response = graph.get_connection(parent.id, api_path, fields: fields)
       response.collect{ |res| self.new(res) }
     end
 
@@ -25,5 +33,9 @@ module Eucalyptus
     def method_missing(method_sym, *args, &block)
       @response.send(method_sym)
     end
+
+    def respond_to?(method_sym, include_private = false)
+      @response.respond_to?(method_sym)
+    end
   end
 end

data/spec/eucalyptus/account_spec.rb

@@ -7,9 +7,18 @@ describe Eucalyptus::Account do
     end
   end
 
-  describe '#ads' do
-    let(:account) { Eucalyptus::Account.all.last }
+  let(:account) { Eucalyptus::Account.all.last }
+
+  describe '#insights' do
+    it 'returns an array of insights for the account' do
+      VCR.use_cassette("resource_insights") do
+        expect(account.insights).to be_a Array
+        expect(account.insights.first).to be_a Eucalyptus::Insight
+      end
+    end
+  end
 
+  describe '#ads' do
     it 'returns a collection of Ad objects which belong to the account' do
       VCR.use_cassette("account_ads") do
         expect(account.ads).to be_a Array
@@ -19,26 +28,20 @@ describe Eucalyptus::Account do
   end
 
   describe '#ad_sets' do
-    let(:account) { Eucalyptus::Account.all.last }
-
     it 'returns a collection of AdSet objects which belong to the account' do
       VCR.use_cassette("account_ad_sets") do
         expect(account.ad_sets).to be_a Array
         expect(account.ad_sets.first).to be_a Eucalyptus::AdSet
       end
     end
-
   end
 
   describe '#campaigns' do
-    let(:account) { Eucalyptus::Account.all.last }
-
     it 'returns a collection of AdSet objects which belong to the account' do
       VCR.use_cassette("account_campaigns") do
         expect(account.campaigns).to be_a Array
         expect(account.campaigns.first).to be_a Eucalyptus::Campaign
       end
     end
-
   end
 end

data/spec/eucalyptus/ad_set_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Eucalyptus::AdSet do
+  before do
+    Eucalyptus.configure do |config|
+      config.access_token = ENV["ACCESS_TOKEN"]
+    end
+  end
+
+  let(:ad_set) { Eucalyptus::AdSet.all.first }
+
+  describe '#insights' do
+    it 'returns an array of insights for the account' do
+      VCR.use_cassette("ad_set_insights") do
+        active_ad_set = Eucalyptus::AdSet.all.find{|ad_set| ad_set.campaign_status == "ACTIVE"}
+        expect(active_ad_set.insights).to be_a Array
+        expect(active_ad_set.insights.first).to be_a Eucalyptus::Insight
+      end
+    end
+  end
+
+  describe '#campaign' do
+    it 'returns the parent campaign for an ad_set' do
+      VCR.use_cassette("ad_set_campaign") do
+        expect(ad_set.campaign).to be_a Eucalyptus::Campaign
+      end
+    end
+  end
+
+  describe '#ads' do
+    it 'returns a collection of Ad objects which belong to the ad_set' do
+      VCR.use_cassette("ad_set_ads") do
+        expect(ad_set.ads).to be_a Array
+        expect(ad_set.ads.first).to be_a Eucalyptus::Ad
+      end
+    end
+  end
+
+  describe 'returning known fields' do
+    it 'returns an object which responds to available fields' do
+      VCR.use_cassette("ad_set") do
+        expect(ad_set).to respond_to :name
+        expect(ad_set).to respond_to :bid_type
+      end
+    end
+  end
+end

data/spec/eucalyptus/ad_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Eucalyptus::Ad do
+  before do
+    Eucalyptus.configure do |config|
+      config.access_token = ENV["ACCESS_TOKEN"]
+    end
+  end
+
+  let(:ad) { Eucalyptus::Ad.all.last }
+
+  describe '#insights' do
+    it 'returns an array of insights for the account' do
+      VCR.use_cassette("ad_set_insights") do
+        active_ad = Eucalyptus::Ad.all.find{|ad| ad.adgroup_status == "ACTIVE"}
+        expect(active_ad.insights).to be_a Array
+        expect(active_ad.insights.first).to be_a Eucalyptus::Insight
+      end
+    end
+  end
+
+  describe '#ad_set' do
+    it 'returns the parent ad_set for this ad' do
+      VCR.use_cassette("ad_adset") do
+        expect(ad.ad_set).to be_a Eucalyptus::AdSet
+      end
+    end
+  end
+
+  describe 'returning known fields' do
+
+    it 'returns an object which responds to available fields' do
+      VCR.use_cassette("ad") do
+        expect(ad).to respond_to :name
+        expect(ad).to respond_to :adgroup_status
+      end
+    end
+  end
+end

data/spec/eucalyptus/campaign_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Eucalyptus::Campaign do
+  before do
+    Eucalyptus.configure do |config|
+      config.access_token = ENV["ACCESS_TOKEN"]
+    end
+  end
+
+  let(:campaign) { Eucalyptus::Campaign.all.last }
+
+  describe '#insights' do
+    it 'returns an array of insights for the account' do
+      VCR.use_cassette("campaign_insights") do
+        expect(campaign.insights).to be_a Array
+        expect(campaign.insights.first).to be_a Eucalyptus::Insight
+      end
+    end
+  end
+
+  describe '#ads' do
+    it 'returns a collection of Ad objects which belong to the campaign' do
+      VCR.use_cassette("campaign_ads") do
+        expect(campaign.ads).to be_a Array
+        expect(campaign.ads.first).to be_a Eucalyptus::Ad
+      end
+    end
+  end
+
+  describe '#ad_sets' do
+    it 'returns a collection of Ad objects which belong to the campaign' do
+      VCR.use_cassette("campaign_ad_sets") do
+        expect(campaign.ad_sets).to be_a Array
+        expect(campaign.ad_sets.first).to be_a Eucalyptus::AdSet
+      end
+    end
+  end
+
+  describe 'returning known fields' do
+    it 'returns an object which responds to available fields' do
+      VCR.use_cassette("campaign") do
+        expect(campaign).to respond_to :name
+      end
+    end
+  end
+end

data/spec/eucalyptus/insight_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Eucalyptus::Insight do
+  before do
+    Eucalyptus.configure do |config|
+      config.access_token = ENV["ACCESS_TOKEN"]
+    end
+  end
+
+  describe '.known_fields' do
+    it 'returns an object which responds to available fields' do
+      VCR.use_cassette('account_insights') do
+        account = Eucalyptus::Account.all.last
+        insights = account.insights.first
+
+        expect(insights).to respond_to :clicks
+        expect(insights).to respond_to :cpc
+      end
+    end
+  end
+end

data/spec/eucalyptus/resource_spec.rb

@@ -1,8 +1,14 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Eucalyptus::Resource do
+  before do
+    Eucalyptus.configure do |config|
+      config.access_token = ENV["ACCESS_TOKEN"]
+    end
+  end
 
   context "given a class which inherits from Eucalyptus::Resource" do
+
     describe ".find" do
       let(:graph) { double(:graph, get_object: { "id" => "123" }) }
 
@@ -14,6 +20,35 @@ describe Eucalyptus::Resource do
         audience = Eucalyptus::CustomAudience.find(123, graph: graph) 
         expect(audience.id).to eql "123"
       end
+
+      context 'when the target class has defined valid known fields' do
+        before do
+          expect(Eucalyptus::CustomAudience.known_fields).to include :name
+        end
+
+        it 'returns an object which responds to those fields' do
+          VCR.use_cassette("custom_audience") do
+            audience = Eucalyptus::CustomAudience.find(6025480500671) 
+            expect(audience).to respond_to :name
+          end
+        end
+
+        it 'returns an object which doesnt respond to unkown fields' do
+          VCR.use_cassette("custom_audience") do
+            audience = Eucalyptus::CustomAudience.find(6025480500671) 
+            expect(audience).to_not respond_to :random_method
+          end
+        end
+
+        it 'accepts extra fields' do
+          graph = double(:graph)
+          expect(graph).to receive(:get_object)
+            .with(123, {fields: [:custom_field, :name, :description]})
+            .and_return([])
+
+          Eucalyptus::CustomAudience.find(123, graph: graph, fields: [:custom_field]) 
+        end
+      end
     end
 
     describe '.all' do
@@ -24,6 +59,35 @@ describe Eucalyptus::Resource do
       it 'returns a collection of resources' do
         expect(Eucalyptus::CustomAudience.all(graph: graph, parent: parent)).to be_a Array
       end
+
+      context 'when the target class has defined valid known fields' do
+        let(:graph) { double(:graph, get_connection: [{ "id" => "123", "name" => "test-audience" }]) }
+
+        before do
+          expect(Eucalyptus::CustomAudience.known_fields).to include :name
+        end
+
+        it 'returns an object which responds to those fields' do
+          VCR.use_cassette("custom_audiences") do
+            audiences = Eucalyptus::CustomAudience.all
+            expect(audiences.first).to respond_to :name
+          end
+        end
+
+        it 'returns an object which doesnt respond to unkown fields' do
+          audiences = Eucalyptus::CustomAudience.all(graph: graph, parent: parent) 
+          expect(audiences.first).to_not respond_to :random_method
+        end
+
+        it 'accepts extra fields' do
+          graph = double(:graph)
+          expect(graph).to receive(:get_connection)
+            .with(123, "customaudiences", {fields: [:custom_field, :name, :description]})
+            .and_return([])
+
+          Eucalyptus::CustomAudience.all(graph: graph, parent: parent, fields: [:custom_field]) 
+        end
+      end
     end
 
     describe '#method_missing' do