zuck 0.0.4

data/spec/lib/zuck_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe Zuck::FbObject do
+
+  before(:all) do
+    Zuck.graph = Koala::Facebook::API.new('AAAEvJ5vzhl8BABhTSazJZB2D0B4N0l242VX22Hg9J2WZA7fptcAztfXxfAZB9mhZB6W1nl5dz5tXMlb9DJk9ibs6RqtP7PtO6a3XCiHWVwZDZD')
+  end
+
+  let(:graph)   { Zuck.graph                                                  }
+  let(:account) { Zuck::AdAccount.new(graph,  {id: "act_10150585630710217"})  }
+  let(:campaign){ Zuck::AdCampaign.new(graph, {id: "6005950787751"}, account) }
+  let(:group)   { Zuck::AdGroup.new(graph,    {id: "6004497038951"}, campaign)}
+  let(:creative){ Zuck::AdCreative.new(graph, {id: "1234567890123"}, group)   }
+
+
+  describe "read only objects" do
+    it "can't be created" do
+      expect{
+        Zuck::AdCreative.create(:x, {}, :y)
+      }.to raise_error(Zuck::Error::ReadOnly)
+    end
+
+    it "can't be saved" do
+      expect{
+        creative.save
+      }.to raise_error(Zuck::Error::ReadOnly)
+    end
+
+    it "can't be destroyed" do
+      expect{
+        creative.destroy
+      }.to raise_error(Zuck::Error::ReadOnly)
+    end
+  end
+
+  describe "talking to facebook" do
+    context "reading" do
+
+      it "a list of ad accounts" do
+        VCR.use_cassette('list_of_ad_accounts') do
+          Zuck::AdAccount.all.should have(1).item
+        end
+      end
+
+      it "a list of ad campaigns" do
+        VCR.use_cassette('list_of_ad_campaigns') do
+          account.ad_campaigns.should have(3).items
+        end
+      end
+
+      it "a list of ad groups" do
+        VCR.use_cassette('list_of_ad_groups') do
+          campaign.ad_groups.should have(1).item
+        end
+      end
+
+      it "list of ad creatives" do
+        VCR.use_cassette('list_of_ad_creatives') do
+          group.ad_creatives.should have(1).items
+        end
+      end
+
+      it "list of all ad creatives of an account" do
+        g = graph
+        Zuck::AdAccount.should_receive(:all).and_return([account])
+        VCR.use_cassette('list_of_all_ad_creatives_of_account') do
+          Zuck::AdCreative.all(g).should have(6).items
+        end
+      end
+
+      context "an id directly" do
+
+        it "with the correct type" do
+          VCR.use_cassette('a_single_campaign') do
+            c = Zuck::AdCampaign.find(6005950787751, graph)
+          end
+        end
+
+        it "with the correct type" do
+          VCR.use_cassette('a_single_account') do
+            c = Zuck::AdAccount.find('act_10150585630710217', graph)
+          end
+        end
+
+        it "when expecting an ad group but the id belongs to a campaign" do
+          expected_error = <<-END_ERROR
+Invalid type.
+
+Expected data['id']="6005950787751" to be equal to one of these:
+  * data['account_id']="10150585630710217"
+  * data['group_id']=nil
+  * data['adgroup_id']=nil
+END_ERROR
+          VCR.use_cassette('a_single_campaign') do
+            expect{
+              c = Zuck::AdGroup.find(6005950787751, graph)
+            }.to raise_error(expected_error)
+          end
+        end
+
+        it "and saving it" do
+          VCR.use_cassette('find_a_single_campaign_and_update_it') do
+            group = Zuck::AdGroup.find(6005859287551, graph)
+            group.name = "My old name"
+            group.save
+            group.name.should == "My old name"
+            group.name = "My new name"
+            group.save
+            group.name.should == "My new name"
+            group.reload
+            group.name.should == "My new name"
+          end
+        end
+
+      end
+    end
+
+
+    context "creating" do
+      it "an ad campaign" do
+        VCR.use_cassette('create_ad_campaign') do
+          o = {daily_budget: 1000, name: "bloody" }
+          campaign = Zuck::AdCampaign.create(graph, o, account)
+          campaign.name.should == "bloody"
+        end
+      end
+
+      it "an ad campaign via an existing ad account" do
+        VCR.use_cassette('create_ad_campaign') do
+          o = {daily_budget: 1000, name: "bloody" }
+          campaign = account.create_ad_campaign(o)
+          campaign.name.should == "bloody"
+        end
+      end
+
+      it "an ad group" do
+        VCR.use_cassette('create_ad_group') do
+          o = {bid_type: 1, max_bid: 1, name: "Rap like me", targeting: '{"countries":["US"]}',
+               creative: '{"type":25,"action_spec":{"action.type":"like", "post":10150420410887685}}'}
+          group = Zuck::AdGroup.create(graph, o, campaign)
+          group.name.should == "Rap like me"
+        end
+      end
+
+      it "an ad group via an existing ad campaign" do
+        VCR.use_cassette('create_ad_group') do
+          o = {bid_type: 1, max_bid: 1, name: "Rap like me", targeting: '{"countries":["US"]}',
+               creative: '{"type":25,"action_spec":{"action.type":"like", "post":10150420410887685}}'}
+          group = campaign.create_ad_group(o)
+          group.name.should == "Rap like me"
+          group.bid_type.should == 1
+        end
+      end
+    end
+
+    context "deleting" do
+      it "an ad group" do
+        VCR.use_cassette('delete_ad_group') do
+          group.destroy.should be_true
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'simplecov'
+SimpleCov.start
+require 'bundler'
+Bundler.require
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+# require File.expand_path("../../config/environment", __FILE__)
+require 'webmock/rspec'
+require 'vcr_setup'
+#require 'capybara/poltergeist'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path("../../spec/support/**/*.rb", __FILE__)].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+
+end
+
+module TestResponseExtensions
+  def json_body
+    JSON.parse(self.body)
+  end
+
+  def unauthorized?
+    code.to_i == 401
+  end
+end
+
+def expect_id_and_return(id, ret_val)
+  lambda { |id| id.to_s.should == id.to_s; ret_val }
+end
+
+
+require File.expand_path("../../lib/zuck", __FILE__)

data/spec/vcr_setup.rb

@@ -0,0 +1,15 @@
+# VCR Config
+require 'vcr'
+FileUtils.mkdir("log") rescue nil
+VCR.configure do |c|
+  dir = File.expand_path("../../spec/fixtures", __FILE__)
+  c.cassette_library_dir      = dir
+  c.hook_into                 :webmock
+  c.ignore_localhost          = true
+  c.default_cassette_options  = {
+    record: :new_episodes,
+    match_requests_on: [:method, :body, :uri]
+  }
+  c.allow_http_connections_when_no_cassette = false
+  c.debug_logger = File.open(File.expand_path("../../log/vcr.log", __FILE__), "w")
+end

data/zuck.gemspec

@@ -0,0 +1,141 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "zuck"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jannis Hermanns"]
+  s.date = "2013-01-03"
+  s.description = "This gem allows to easily access facebook's ads api in ruby. See https://developers.facebook.com/docs/reference/ads-api/"
+  s.email = "jannis@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".rvmrc",
+    ".travis.yml",
+    ".yardopts",
+    "CHANGELOG.markdown",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile.dist",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "console",
+    "lib/zuck.rb",
+    "lib/zuck/facebook/ad_account.rb",
+    "lib/zuck/facebook/ad_campaign.rb",
+    "lib/zuck/facebook/ad_creative.rb",
+    "lib/zuck/facebook/ad_group.rb",
+    "lib/zuck/facebook/targeting_spec.rb",
+    "lib/zuck/fb_object.rb",
+    "lib/zuck/fb_object/dsl.rb",
+    "lib/zuck/fb_object/error.rb",
+    "lib/zuck/fb_object/hash_delegator.rb",
+    "lib/zuck/fb_object/helpers.rb",
+    "lib/zuck/fb_object/read.rb",
+    "lib/zuck/fb_object/read_only.rb",
+    "lib/zuck/fb_object/write.rb",
+    "lib/zuck/koala/koala_methods.rb",
+    "spec/fixtures/a_single_account.yml",
+    "spec/fixtures/a_single_campaign.yml",
+    "spec/fixtures/create_ad_campaign.yml",
+    "spec/fixtures/create_ad_group.yml",
+    "spec/fixtures/delete_ad_group.yml",
+    "spec/fixtures/find_a_single_campaign_and_update_it.yml",
+    "spec/fixtures/list_of_ad_accounts.yml",
+    "spec/fixtures/list_of_ad_campaigns.yml",
+    "spec/fixtures/list_of_ad_creatives.yml",
+    "spec/fixtures/list_of_ad_groups.yml",
+    "spec/fixtures/list_of_all_ad_creatives_of_account.yml",
+    "spec/fixtures/reach_for_invalid_keyword.yml",
+    "spec/fixtures/reach_for_valid_keywords.yml",
+    "spec/fixtures/reach_for_valid_keywords_male_young.yml",
+    "spec/lib/zuck/facebook/ad_account_spec.rb",
+    "spec/lib/zuck/facebook/ad_campaign_spec.rb",
+    "spec/lib/zuck/facebook/targeting_spec_spec.rb",
+    "spec/lib/zuck/fb_object/helpers_spec.rb",
+    "spec/lib/zuck/koala/koala_methods_spec.rb",
+    "spec/lib/zuck/util/hash_delegator_spec.rb",
+    "spec/lib/zuck_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/vcr_setup.rb",
+    "zuck.gemspec"
+  ]
+  s.homepage = "http://github.com/jayniz/zuck"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby adapter to facebook's ad api"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rvm>, [">= 0"])
+      s.add_runtime_dependency(%q<bundler>, [">= 0"])
+      s.add_runtime_dependency(%q<koala>, [">= 1.5"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_development_dependency(%q<guard-yard>, [">= 0"])
+      s.add_development_dependency(%q<growl>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
+    else
+      s.add_dependency(%q<rvm>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<koala>, [">= 1.5"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_dependency(%q<guard-yard>, [">= 0"])
+      s.add_dependency(%q<growl>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<rb-fsevent>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rvm>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<koala>, [">= 1.5"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+    s.add_dependency(%q<guard-yard>, [">= 0"])
+    s.add_dependency(%q<growl>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<rb-fsevent>, [">= 0"])
+  end
+end
+