fbaa_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aad5db93bd6c16b8f66eaf86ebec17144a524ad3
+  data.tar.gz: 57c3c9d06cc4385bb98d44b4a0ea88d599b54034
+SHA512:
+  metadata.gz: b0cb23a0191b6bc39e0b0c0f152ef58135b47e2eafe8e8ac0866d1585dd474bf6aa59a22a3dc63d724f188bc9d22999ff32afe9f81bdcef78ae1b9576d3a6ab8
+  data.tar.gz: 3b8cf54610db52483bbe71945ecb04e6d39911b1a23546cabc574ee58ebbd0cc73c7b646bfed0bb85b765c545f127ebf77a674cf1d131b544373e063bdec6384

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fbaa_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+[![Circle CI](https://circleci.com/gh/constantcontact/fbaa_api.svg?style=svg)](https://circleci.com/gh/constantcontact/fbaa_api)
+
+# FbaaApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fbaa_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fbaa_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fbaa_api
+
+## Configuration
+
+Configure the gem using the ```#configure``` method like so:
+
+```ruby
+  FbaaApi.configure do |c| 
+    c.base_url    = 'https://example.com' # mandatory
+    c.token       = 'yourtoken1234'       # mandatory, authentication token
+    c.api_version = 'v1'                  # optional, defaults to v1
+    c.logger      = Logger.new            * optional, defaults to STDOUT
+  end
+```
+
+## Usage
+
+```ruby
+  FbaaApi.configure do |c| 
+    # c.base_url = ... etc, etc
+  end
+
+  client = FbaaApi::Client.new
+
+  client.create_ad(params)
+  client.update_ad(id, params)
+  client.get_ad(id, params)
+  client.validate_image(params)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fbaa_api.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fbaa_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

data/bin/setup

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

data/fbaa_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fbaa_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fbaa_api'
+  spec.version       = FbaaApi::VERSION
+  spec.authors       = ['Jarrod Spillers']
+  spec.email         = ['jspillers@constantcontact.com']
+
+  spec.summary       = %q{API client for facebook ads adapter}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/constantcontact/fbaa_api'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+
+  spec.add_dependency 'rspec_junit_formatter', '0.2.2'
+  spec.add_dependency 'faraday', '~> 0.9.2'
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_dependency 'json', '~> 1.8.3'
+end

data/lib/fbaa_api/client.rb

@@ -0,0 +1,74 @@
+module FbaaApi
+  class Client
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    def create_ad(params = {})
+      post 'ads', params
+    end
+
+    def update_ad(id, params = {})
+      put "ads/#{id}", params
+    end
+
+    def get_ad(id, params = {})
+      get "ads/#{id}", params
+    end
+
+    def validate_image(params = {})
+      get "image_validations", params
+    end
+
+    private
+
+    def fbaa_url
+      @fbaa_url ||= "#{config.base_url}/api/#{config.api_version}"
+    end
+
+    def connection(opts = {})
+      opts[:headers] ||= { 'Accept' => 'application/json' }
+      config.logger.info("Fbaa::Client - fbaa_url #{fbaa_url}")
+      Faraday.new(url: fbaa_url) do |faraday|
+        faraday.headers = opts[:headers]
+        # this is required to be after headers to work
+        faraday.basic_auth 'roving', config.fbaa_password
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def request(method, path, params = {})
+      config.logger.info("Fbaa::Client - path #{path}")
+      response = connection.send(method, path) do |request|
+        request.body = params if [:post, :put].include? method
+        request.params = params
+      end
+      config.logger.info("Fbaa::Client - status #{response.status}")
+      config.logger.info("Fbaa::Client - body #{response.body}")
+
+      { status: response.status, body: JSON.parse(response.body) }
+    rescue JSON::ParserError
+      { status: 500, body: { error_messages: "JSON::ParseError #{response.body}" } }
+    end
+
+    def config
+      FbaaApi.configuration
+    end
+
+  end
+end
+

data/lib/fbaa_api/configuration.rb

@@ -0,0 +1,26 @@
+module FbaaApi
+  class Configuration
+    # Sets which FBAA API version to use
+    attr_accessor :api_version
+
+    # Sets base url for FBAA
+    attr_accessor :base_url
+
+    # Sets ctct token
+    attr_accessor :token
+
+    # Sets ctct token
+    attr_accessor :fbaa_password
+
+    # Set a logger, or use stdout by default
+    attr_accessor :logger
+
+    def initialize
+      @api_version   = 'v1'
+      @base_url      = ''
+      @fbaa_password = ''
+      @logger        = Logger.new(STDOUT)
+    end
+
+  end
+end

data/lib/fbaa_api/version.rb

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

data/lib/fbaa_api.rb

@@ -0,0 +1,30 @@
+require 'logger'
+require 'json'
+require 'fbaa_api/client'
+require "fbaa_api/version"
+require "fbaa_api/configuration"
+require 'faraday'
+require 'faraday_middleware'
+
+module FbaaApi
+  class << self
+    attr_writer :configuration
+
+    def new
+      Client.new
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset
+      self.configuration = Configuration.new
+    end
+  end
+
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: fbaa_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jarrod Spillers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: API client for facebook ads adapter
+email:
+- jspillers@constantcontact.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fbaa_api.gemspec
+- lib/fbaa_api.rb
+- lib/fbaa_api/client.rb
+- lib/fbaa_api/configuration.rb
+- lib/fbaa_api/version.rb
+homepage: https://github.com/constantcontact/fbaa_api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: API client for facebook ads adapter
+test_files: []