facebook_ads 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54f327543c28ab824b5defb8dfedaa8559579c8c
-  data.tar.gz: f38f4804345dcd76a557caee36f32dd290b24cf2
+  metadata.gz: f8117b9273b5c021539acebd28147725fc64aa5b
+  data.tar.gz: 9896c67db75495e96eddcce3e0a26740223fd1a4
 SHA512:
-  metadata.gz: 99a0f3b2ef4e464b0a8ed19a632359031a5b25f4aa6e7f7e322741ea7e033bfc93636d7b8be1fa01f69d9bdbaa90dee2335f63166fe66d4c81990ba90fdb4889
-  data.tar.gz: 9dcee742fa347d78707f29fc3318b95eb2df13efe8c7d01b98c10b0be0e0f26902b8a1aa4e89e6f56293a16782ce141f16c32bcac02acb9519dbba10a42a8f74
+  metadata.gz: 30e04d2e719a14ba63d7886acb557d05061f997e00d09fe0b566af53d772867b4f3100c944c7bc3e7db0ad220225ee42502f0afa6385c158c6b5a399bffbe069
+  data.tar.gz: 167e49f93ac8c9d18cf13aa2b753a3b57795aabd172030490baabdf9fd61df2b2ab99a2b85f322a905be33dca78b926d44affc1f916534f9a9564636cb8c5764

data/.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 test_access_token
+test_business_id
 coverage
+*.gem

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - bin/console
+  TargetRubyVersion: 2.2
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -5,4 +5,4 @@ branches:
   only:
     - master
 cache: bundler
-script: bundle exec rspec spec
+script: bundle exec rake test

data/Gemfile

@@ -2,15 +2,14 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'bundler', '~> 1.7'
-  gem 'rake', '~> 10.0'
   gem 'pry', '~> 0.10'
   gem 'awesome_print', '~> 1.7'
 end
 
 group :test do
-  gem 'rspec', '~> 3.4'
-  gem 'webmock', '~> 2.1'
-  gem 'sinatra', '~> 1.4'
+  gem 'rake'
+  gem 'minitest'
+  gem 'webmock'
+  gem 'vcr'
   gem 'coveralls', require: false
 end

data/Gemfile.lock

@@ -1,129 +1,81 @@
 PATH
   remote: .
   specs:
-    facebook_ads (0.1.5)
-      activesupport (~> 4.2)
+    facebook_ads (0.1.7)
       hashie (~> 3.4)
-      httmultiparty (~> 0.3)
+      rest-client (>= 1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.7.1)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    addressable (2.4.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     awesome_print (1.7.0)
     coderay (1.1.1)
-    coveralls (0.8.10)
-      json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.11.0)
+    coveralls (0.8.17)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-      tins (~> 1.6.0)
+      tins (~> 1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.20160310)
+    domain_name (0.5.20161129)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.9.14-java)
-    hashdiff (0.3.0)
-    hashie (3.4.4)
-    httmultiparty (0.3.16)
-      httparty (>= 0.7.3)
-      mimemagic
-      multipart-post
-    http-cookie (1.0.2)
+    hashdiff (0.3.2)
+    hashie (3.4.6)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
-    httparty (0.14.0)
-      multi_xml (>= 0.5.2)
-    i18n (0.7.0)
-    json (1.8.3)
+    json (2.0.2)
     method_source (0.8.2)
-    mime-types (2.99.1)
-    mimemagic (0.3.2)
-    minitest (5.9.0)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.10.1)
     netrc (0.11.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry (0.10.4-java)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-      spoon (~> 0.0)
-    rack (1.6.0)
-    rack-protection (1.5.3)
-      rack
-    rake (10.5.0)
-    rest-client (1.8.0)
+    public_suffix (2.0.4)
+    rake (12.0.0)
+    rest-client (2.0.0)
       http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     safe_yaml (1.0.4)
-    simplecov (0.11.1)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sinatra (1.4.5)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
     slop (3.6.0)
-    spoon (0.0.4)
-      ffi
-    term-ansicolor (1.3.2)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tilt (1.4.1)
-    tins (1.6.0)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
+    thor (0.19.4)
+    tins (1.13.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.2)
-    webmock (2.1.0)
+    vcr (3.0.3)
+    webmock (2.3.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
   awesome_print (~> 1.7)
-  bundler (~> 1.7)
   coveralls
   facebook_ads!
+  minitest
   pry (~> 0.10)
-  rake (~> 10.0)
-  rspec (~> 3.4)
-  sinatra (~> 1.4)
-  webmock (~> 2.1)
+  rake
+  vcr
+  webmock
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/{README.markdown → README.md}

@@ -2,13 +2,13 @@
 [![Build Status](https://travis-ci.org/cte/facebook-ads-sdk-ruby.svg?branch=master)](https://travis-ci.org/cte/facebook-ads-sdk-ruby)
 [![Coverage Status](https://coveralls.io/repos/github/cte/facebook-ads-sdk-ruby/badge.svg)](https://coveralls.io/github/cte/facebook-ads-sdk-ruby)
 
-## [Facebook Marketing API](https://developers.facebook.com/docs/marketing-apis) SDK for Ruby
+# [Facebook Marketing API](https://developers.facebook.com/docs/marketing-apis) SDK for Ruby
 
 ![Facebook Ads](http://i.imgur.com/GrxAj07.png)
 
 This gem allows you to manage your Facebook Ads using a ruby interface. It allows you to list, create, update and destroy Facebook Ad objects (campaigns, ad sets, ads, etc) and get real-time insights about the performance of Facebook Ads.
 
-### Install
+## Install
 
 ```bash
 gem install facebook_ads
@@ -20,7 +20,7 @@ Or, add the following to your Gemfile:
 gem 'facebook_ads', '~> 0.1'
 ```
 
-### Permissions
+## Permissions
 
 You'll need an [Access Token](https://developers.facebook.com/docs/marketing-api/authentication) with `ads_management` permissions in order to use Facebook's Marketing API.
 
@@ -28,7 +28,7 @@ You'll need an [Access Token](https://developers.facebook.com/docs/marketing-api
 FacebookAds.access_token = '[YOUR_ACCESS_TOKEN]'
 ```
 
-### Console
+## Console
 
 This gem provides a console using [Pry](https://github.com/pry/pry) and [AwesomePrint](https://github.com/awesome-print/awesome_print) for you to test & debug.
 It reads the Access Token from a file called test_access_token.
@@ -38,7 +38,7 @@ echo [YOUR_ACCESS_TOKEN] > test_access_token
 bin/console
 ```
 
-### Usage Examples
+## Usage Examples
 
 A strong understanding of the Facebook Ads [object structure](https://developers.facebook.com/docs/marketing-api/buying-api) will greatly help you use this gem.
 
@@ -60,6 +60,8 @@ The typical flow is as follows:
 
 You'll find usage examples for each of these 7 objects below.
 
+___
+
 ### [Ad Accounts](https://developers.facebook.com/docs/marketing-api/reference/ad-account) (Fetch, Find, Update)
 
 Fetch all accounts that can be accessed using your access token:
@@ -86,6 +88,8 @@ account.update(name: 'ReFuel4') # Returns a boolean.
 
 The list of fields that can be updated is [here](https://developers.facebook.com/docs/marketing-api/reference/ad-account#Updating).
 
+___
+
 ### [Ad Campaigns](https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group) (Fetch, Find, Create, Update, Destroy)
 
 Fetch all active campaigns:
@@ -132,6 +136,8 @@ Destroy a campaign:
 campaign.destroy
 ```
 
+___
+
 ### [Ad Images](https://developers.facebook.com/docs/marketing-api/reference/ad-image) (Fetch, Find, Create, Destroy)
 
 Notes:
@@ -164,6 +170,8 @@ Destroy images:
 ad_images.map(&:destroy)
 ```
 
+___
+
 ### [Ad Creatives](https://developers.facebook.com/docs/marketing-api/reference/ad-creative) (Fetch, Find, Create, Update, Destroy)
 
 Notes:
@@ -224,6 +232,8 @@ Destroy a creative:
 ad_creative.destroy
 ```
 
+___
+
 ### [Ad Sets](https://developers.facebook.com/docs/marketing-api/reference/ad-campaign) (Fetch, Find, Create, Update, Destroy)
 
 Notes:
@@ -273,12 +283,14 @@ ad_set = campaign.create_ad_set(
     object_store_url: 'http://play.google.com/store/apps/details?id=com.tophatter',
     custom_event_type: 'PURCHASE'
   },
-  optimization_goal: 'OFFSITE_CONVERSIONS', # See FacebookAds::AdSet::OPTIMIZATION_GOALS.
+  optimization_goal: 'OFFSITE_CONVERSIONS',
   daily_budget: 500, # This is in cents, so the daily budget here is $5.
-  billing_event: 'IMPRESSIONS', # See FacebookAds::AdSet::BILLING_EVENTS for a list of all billing events.
+  billing_event: 'IMPRESSIONS',
   status: 'PAUSED'
 )
 ```
+See FacebookAds::AdSet::OPTIMIZATION_GOALS for a list of all optimization goals.
+See FacebookAds::AdSet::BILLING_EVENTS for a list of all billing events.
 
 Find an ad set by ID:
 ```ruby
@@ -299,6 +311,8 @@ Destroy an ad set:
 ad_set.destroy
 ```
 
+___
+
 ### [Ads](https://developers.facebook.com/docs/marketing-api/reference/adgroup) (Fetch, Find, Create, Update, Destroy)
 
 You interact with ads via an ad set:
@@ -351,6 +365,8 @@ Destroy an ad:
 ad.destroy
 ```
 
+___
+
 ### [Ad Insights](https://developers.facebook.com/docs/marketing-api/insights/overview) (Fetch)
 
 Fetch today's insights for an account:
@@ -373,8 +389,25 @@ Fetch yesterday's insights for a campaign:
 account.ad_campaigns.last.ad_insights(range: Date.yesterday..Date.yesterday)
 ```
 
-### @TODO:
+___
+
+### [Product Catalogs](https://developers.facebook.com/docs/marketing-api/reference/product-catalog)
+
+List all product catalogs:
+```ruby
+FacebookAds::AdProductCatalog.all
+```
+
+Create a new product catalog:
+```ruby
+catalog = FacebookAds::AdProductCatalog.create(name: 'test')
+```
+
+Delete a product catalog:
+```ruby
+catalog.destroy
+```
+
+## @TODO:
 
-* Unit tests (add rspec - need to build out the tests now).
 * [Batch operations](https://developers.facebook.com/docs/marketing-api/batch-requests).
-* Upgrade to [2.7](https://developers.facebook.com/docs/marketing-api/versions).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/bin/console

@@ -5,7 +5,21 @@ require 'facebook_ads'
 require 'awesome_print'
 require 'pry'
 
-FacebookAds.access_token = File.read('test_access_token').squish
+begin
+  FacebookAds.access_token = File.read('test_access_token').chop
+  puts "access_token: #{FacebookAds.access_token}"
+rescue Errno::ENOENT
+  puts 'Create a test_access_token file and add your Access Token to it.'
+  exit
+end
+
+begin
+  FacebookAds.business_id = File.read('test_business_id').chop
+  puts "business_id: #{FacebookAds.business_id}"
+rescue Errno::ENOENT
+  puts 'Create a test_business_id file and add your Business ID to it.'
+end
+
 FacebookAds.logger = Logger.new(STDOUT)
 FacebookAds.logger.level = Logger::Severity::DEBUG
 

data/facebook_ads.gemspec

@@ -1,26 +1,24 @@
 # To release a new version:
 # gem build facebook_ads.gemspec
-# gem push facebook_ads-0.1.5.gem
+# gem push facebook_ads-0.1.7.gem
 Gem::Specification.new do |s|
   s.name        = 'facebook_ads'
-  s.version     = '0.1.5'
+  s.version     = '0.1.7'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['MIT']
   s.authors     = ['Chris Estreich']
   s.email       = 'cestreich@gmail.com'
-  s.homepage    = 'https://github.com/cte/facebook-ads-sdk-ruby'
-  s.summary     = "Facebook Marketing API SDK for Ruby."
-  s.description = "This gem allows to easily manage your Facebook ads via Facebook's Marketing API in ruby."
-
-  s.extra_rdoc_files = ['README.markdown']
-
+  s.homepage    = 'https://github.com/cte/facebook-ruby-ads-sdk'
+  s.summary     = 'Facebook Marketing API SDK for Ruby.'
+  s.description = "This gem allows to easily manage your Facebook ads via \
+                   Facebook's Marketing API in ruby."
+  s.extra_rdoc_files = ['README.md']
   s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
   s.require_paths = ['lib']
-
   s.required_ruby_version = '~> 2.0'
-
-  s.add_dependency 'activesupport', '~> 4.2'
-  s.add_dependency 'httmultiparty', '~> 0.3'
+  s.add_dependency 'rest-client', '>= 1.6'
   s.add_dependency 'hashie', '~> 3.4'
 end