fake_fb_marketing_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9e916084f69d4c775a025c3bb6948843c85e121
+  data.tar.gz: f99a3b4b67c3f6209a82e26fb45903e4f85388f7
+SHA512:
+  metadata.gz: 7e2bad6aae8e22ac811433dbaf252447b8b3529cdaa5406d26092db792e867ab1ce4150615d068e1450d7a6e04e6066f23e7ffe225a416ea98d31d92d04d17b4
+  data.tar.gz: d57770fdd7181beed6a70d317330c9af955f0be75ef9c4ee8cb95078922757600a3836b0c1d53ea79c53f038e2182b378e2987a55d77c7c3cae7e64c4c06871c

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+lib/fake_fb_marketing_api/log/
+
+# rspec failure tracking
+.rspec_status
+
+# remove all vim files
+**/*.swo
+**/*.swn
+**/*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.17.1
+
+install: bundle install --jobs=3 --retry=3
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true # prevents nokogiri from downloading slooooow librarie

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mike@humanagency.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fake_fb_marketing_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    fake_fb_marketing_api (0.0.1)
+      sinatra (~> 2.0)
+      we-call (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    byebug (10.0.2)
+    capybara (3.13.2)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.2)
+      xpath (~> 3.2)
+    capybara_discoball (0.1.0)
+      capybara (>= 2.7, < 4)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    debug_inspector (0.0.3)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faker (1.9.1)
+      i18n (>= 0.7)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday-sunset (0.2.0)
+      faraday (>= 0.9.0, < 1)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.10.0)
+    hashdiff (0.3.8)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    koala (3.0.0)
+      addressable
+      faraday
+      json (>= 1.8)
+    method_source (0.9.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    multipart-post (2.0.0)
+    mustermann (1.0.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    pry-stack_explorer (0.4.9.3)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    regexp_parser (1.3.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    tilt (2.0.9)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    we-call (0.9.0)
+      faraday (>= 0.9.0, < 1)
+      faraday-sunset (~> 0.2)
+      faraday_middleware (~> 0.10)
+      typhoeus (~> 1.3)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  capybara_discoball
+  fake_fb_marketing_api!
+  faker (~> 1.9)
+  faraday
+  koala (~> 3.0)
+  pry
+  pry-byebug
+  pry-stack_explorer
+  rack-test (~> 1.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.15.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mike Menne
+
+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,63 @@
+# FakeFbMarketingApi
+
+This sinatra server provides a reverse proxy to the Facebook graph API at `graph.facebook.com`.
+
+Select APIs can intercepted and return static responses.
+
+## Setup
+
+### Koala
+
+These instructions assume that you are using [Koala](https://github.com/arsduo/koala) as your interface to the Facebook graph API.
+
+In order to use this reverse proxy, you will need to redirect all Koala requests to your local `fake-fb-marketing-api` server.
+
+In your Koala config, replace the URL for FB:
+```
+Koala.configure do |config|
+  if Rails.env.development?
+    config.graph_server = 'localhost:9292'
+  end
+end
+``` 
+
+In your Koala config, you will also need to disable SSL since our local server is not running with certificates:
+```
+Koala.http_service.http_options = {
+  use_ssl: false
+}
+```
+
+You will also need to set several `ENV` variables:
+```
+export FACEBOOK_AD_ACCOUNT_ID='xxxxxx' 
+export BRAND_AWARENESS_CAMPAIGN_ID='xxxxxx' 
+export LINK_CLICKS_CAMPAIGN_ID='xxxxxx' 
+export VIDEO_VIEWS_CAMPAIGN_ID='xxxxxx' 
+export REACH_CAMPAIGN_ID='xxxxxx' 
+export POST_ENGAGEMENT_CAMPAIGN_ID='xxxxxx' 
+export PAGE_LIKES_CAMPAIGN_ID='xxxxxx' 
+```
+
+It may be easier to run foreman with a separate ENV file that will set these values:
+```
+foreman start --f Procfile.dev --env fake.env
+```
+*Note* Foreman is particular about the format of the ENV file and does not support dot_env format (comments, etc.).  This prevents us from using our normal `.env.development` to set variables for the entiree process.
+
+Any calls that create an ad account will return the value in the `FACEBOOK_AD_ACCOUNT_ID`.  
+
+Any campaigns created will return the value in the `XXX_CAMPAIGN_ID` variables.
+ 
+## Notes
+
+### Development
+
+### Test
+
+### Staging
+
+### Production
+### Limitations
+
+This server forwards all web requests via a Faraday wrapper.  It does not support `keep-alive` `Connection` header.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fake_fb_marketing_api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# config.ru
+
+$LOAD_PATH << File.expand_path('lib', __dir__)
+require 'fake_fb_marketing_api/application'
+
+$stdout.sync = true
+
+run FakeFbMarketingApi::Application.new

data/fake_fb_marketing_api.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake_fb_marketing_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'fake_fb_marketing_api'
+  gem.version       = FakeFbMarketingApi::VERSION
+  gem.authors       = ['Mike Menne']
+  gem.email         = ['mike@humanagency.org']
+
+  gem.summary       = 'Provides a stubbed interface for select Facebook Marketing API endpoints'
+  gem.description   = 'The key purpose of this gem is to allow developers the ability to stub the endpoints related the the Facebook Business API.  Commands such as creating ad accounts can not be reversed and count against quota.'
+  gem.homepage      = 'https://humanagency.org/'
+  gem.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if gem.respond_to?(:metadata)
+    # gem.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    # gem.metadata["homepage_uri"] = gem.homepage
+    # gem.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # gem.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gem.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|gem|features)/}) }
+  end
+  gem.required_ruby_version = '>= 2.4.3'
+
+  gem.add_development_dependency 'bundler', '~> 1.15'
+  gem.add_development_dependency 'capybara_discoball'
+  gem.add_development_dependency 'faker', '~> 1.9'
+  gem.add_development_dependency 'faraday'
+  gem.add_development_dependency 'koala', '~> 3.0'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-byebug'
+  gem.add_development_dependency 'pry-stack_explorer'
+  gem.add_development_dependency 'rack-test', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'webmock'
+  gem.add_runtime_dependency 'sinatra', '~> 2.0'
+  gem.add_runtime_dependency 'we-call', '~> 0.9'
+end