balihoo_lpc_client 0.2.0.pre

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.10.6
+addons:
+    code_climate:
+        repo_token: 02572c3859b3e824658e6913a2d218c08c302ade00121cba0bcc03bef41a51d6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bluewater, Inc.
+
+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,45 @@
+[![Code Climate](https://codeclimate.com/github/riverock/balihoo_lpc_client/badges/gpa.svg)](https://codeclimate.com/github/riverock/balihoo_lpc_client)
+[![Test Coverage](https://codeclimate.com/github/riverock/balihoo_lpc_client/badges/coverage.svg)](https://codeclimate.com/github/riverock/balihoo_lpc_client/coverage)
+[![Build Status](https://travis-ci.org/riverock/balihoo_lpc_client.svg?branch=develop)](https://travis-ci.org/riverock/balihoo_lpc_client)
+
+# BalihooLpcClient
+
+This provides a ruby wrapper around the Balihoo Local Partner Connect API.
+
+**NOTE: It is still under development and all the available endpoints have not yet been
+implemented.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'balihoo_lpc_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install balihoo_lpc_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/riverock/balihoo_lpc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/balihoo_lpc_client.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'balihoo_lpc_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "balihoo_lpc_client"
+  spec.version       = BalihooLpcClient::VERSION
+  spec.authors       = ["JD Guzman", "Nic Boie"]
+  spec.email         = ["jd.guzman@bluewaterbrand.com", "nic.boie@bluewaterbrand.com"]
+
+  spec.summary       = %q{Ruby Client for Balihoo's LPC API}
+  spec.description   = %q{Ruby Client for Balihoo's LPC API}
+  spec.homepage      = "https://github.com/riverock/balihoo_lpc"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency "httparty"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "webmock"
+end

data/bin/console

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

@@ -0,0 +1,31 @@
+module BalihooLpcClient
+  class Configuration
+    attr_accessor :api_base, :api_version, :brand_key, :api_key, :location_key,
+                  :user_id, :group_id, :client_id, :client_api_key
+
+    def initialize
+      defaults.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def self.create
+      config = new
+      yield config if block_given?
+      config
+    end
+
+    def url
+      [api_base, api_version].join(?/)
+    end
+
+    private
+
+    def defaults
+      {
+        api_base: "https://bac.dev.balihoo-cloud.com/localdata",
+        api_version: "v1.0"
+      }
+    end
+  end
+end

data/lib/balihoo_lpc_client/connection.rb

@@ -0,0 +1,37 @@
+module BalihooLpcClient
+  class Connection
+    attr_accessor :config
+
+    def initialize(config:)
+      self.config = config
+    end
+
+    def authenticate!
+      auth = Request::Authentication.new(connection: self)
+      auth.authenticate!
+    end
+
+    def campaigns(params: {})
+      validate_params!(params: params)
+      Request::Campaigns.new(connection: self, params: params).fetch
+    end
+
+    def campaigns_with_tactics(params: {})
+      validate_params!(params: params)
+      Request::CampaignsWithTactics.new(connection: self, params: params).fetch
+    end
+
+    def metrics(tactic_id:, params: {})
+      validate_params!(params: params)
+      Request::Metrics.new(connection: self, params: params, tactic_id: tactic_id).fetch
+    end
+
+    private
+
+    def validate_params!(params:)
+      if config.location_key.nil? && params[:locations].nil?
+        raise ApiOptionError, 'must pass opts[:locations] array since no location_key given'
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/request/api_base.rb

@@ -0,0 +1,24 @@
+module BalihooLpcClient
+  module Request
+    class ApiBase < Base
+      attr_accessor :params
+
+      def initialize(connection:, params:)
+        super(connection: connection)
+        self.params = params
+      end
+
+      private
+
+      def opts
+        {
+          headers: {
+            'X-ClientId' => connection.config.client_id,
+            'X-ClientApiKey' => connection.config.client_api_key
+          },
+          query: params
+        }
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/request/authentication.rb

@@ -0,0 +1,32 @@
+module BalihooLpcClient
+  module Request
+    class Authentication < Base
+      def authenticate!
+        response = self.class.post('/genClientAPIKey', opts)
+        handle_errors_with(klass: AuthenticationError, response: response)
+        handle_success(response.parsed_response)
+      end
+
+      private
+
+      def opts
+        {
+          query: {
+            brandKey: connection.config.brand_key,
+            apiKey: connection.config.api_key,
+            locationKey: connection.config.location_key,
+            userId: connection.config.user_id,
+            groupId: connection.config.group_id
+          }
+        }
+      end
+
+      def handle_success(data)
+        auth = Response::Authentication.new(data)
+        config.client_id = auth.client_id
+        config.client_api_key = auth.client_api_key
+        data
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/request/base.rb

@@ -0,0 +1,26 @@
+module BalihooLpcClient
+  module Request
+    class Base
+      include HTTParty
+
+      attr_accessor :connection
+
+      def initialize(connection:)
+        self.connection = connection
+        self.class.base_uri config.url
+      end
+
+      private
+
+      def config
+        connection.config
+      end
+
+      def handle_errors_with(klass:, response:)
+        unless response.parsed_response.is_a?(Hash)
+          raise klass, response.parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/request/campaigns.rb

@@ -0,0 +1,11 @@
+module BalihooLpcClient
+  module Request
+    class Campaigns < ApiBase
+      def fetch
+        self.class.get('/campaigns', opts).parsed_response.map do |result|
+          Response::Campaign.new result
+        end
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/request/campaigns_with_tactics.rb

@@ -0,0 +1,11 @@
+module BalihooLpcClient
+  module Request
+    class CampaignsWithTactics < ApiBase
+      def fetch
+        self.class.get('/campaignswithtactics', opts).parsed_response.map do |result|
+          Response::Campaign.new result
+        end
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/request/metrics.rb

@@ -0,0 +1,17 @@
+module BalihooLpcClient
+  module Request
+    class Metrics < ApiBase
+      attr_accessor :tactic_id
+
+      def initialize(connection:, params:, tactic_id:)
+        super(connection: connection, params: params)
+        self.tactic_id = tactic_id
+      end
+
+      def fetch
+        r = self.class.get("/tactic/#{tactic_id}/metrics", opts).parsed_response
+        Response::Metric.new r
+      end
+    end
+  end
+end

data/lib/balihoo_lpc_client/response/authentication.rb

@@ -0,0 +1,10 @@
+module BalihooLpcClient
+  module Response
+    class Authentication < Hashie::Dash
+      include Hashie::Extensions::Dash::PropertyTranslation
+      
+      property :client_id, from: 'clientId'
+      property :client_api_key, from: 'clientApiKey'
+    end
+  end
+end

data/lib/balihoo_lpc_client/response/campaign.rb

@@ -0,0 +1,16 @@
+module BalihooLpcClient
+  module Response
+    class Campaign < Hashie::Dash
+      include Hashie::Extensions::Dash::PropertyTranslation
+      include Hashie::Extensions::Dash::Coercion
+
+      property :id, from: 'id'
+      property :title, from: 'title'
+      property :description, from: 'description'
+      property :start, from: 'start'
+      property :end, from: 'end'
+      property :status, from: 'status'
+      property :tactics, from: 'tactics', coerce: Array[Tactic]
+    end
+  end
+end

data/lib/balihoo_lpc_client/response/metric.rb

@@ -0,0 +1,16 @@
+module BalihooLpcClient
+  module Response
+    class Metric < Hashie::Dash
+      include Hashie::Extensions::Dash::PropertyTranslation
+
+      property :tactic_ids, from: 'tacticIds', coerce: Array
+      property :channel, from: 'channel'
+      property :clicks, from: 'clicks'
+      property :spend, from: 'spend'
+      property :impressions, from: 'impressions'
+      property :ctr, from: 'ctr'
+      property :avg_cpc, from: 'avgCpc'
+      property :avg_cpm, from: 'avgCpm'
+    end
+  end
+end

data/lib/balihoo_lpc_client/response/tactic.rb

@@ -0,0 +1,15 @@
+module BalihooLpcClient
+  module Response
+    class Tactic < Hashie::Dash
+      include Hashie::Extensions::Dash::PropertyTranslation
+      
+      property :id, from: 'id'
+      property :title, from: 'title'
+      property :start, from: 'start'
+      property :end, from: 'end'
+      property :channel, from: 'channel'
+      property :description, from: 'description'
+      property :creative, from: 'creative'
+    end
+  end
+end

data/lib/balihoo_lpc_client/version.rb

@@ -0,0 +1,3 @@
+module BalihooLpcClient
+  VERSION = "0.2.0.pre"
+end

data/lib/balihoo_lpc_client.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+require 'hashie'
+
+require 'balihoo_lpc_client/version'
+require 'balihoo_lpc_client/configuration'
+require 'balihoo_lpc_client/connection'
+require 'balihoo_lpc_client/request/base'
+require 'balihoo_lpc_client/request/api_base'
+require 'balihoo_lpc_client/request/authentication'
+require 'balihoo_lpc_client/request/campaigns'
+require 'balihoo_lpc_client/request/campaigns_with_tactics'
+require 'balihoo_lpc_client/request/metrics'
+require 'balihoo_lpc_client/response/authentication'
+require 'balihoo_lpc_client/response/tactic'
+require 'balihoo_lpc_client/response/campaign'
+require 'balihoo_lpc_client/response/metric'
+
+module BalihooLpcClient
+  class BalihooLpcError < StandardError; end
+  class AuthenticationError < BalihooLpcError; end
+  class ApiOptionError < BalihooLpcError; end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: balihoo_lpc_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0.pre
+platform: ruby
+authors:
+- JD Guzman
+- Nic Boie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  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: webmock
+  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'
+description: Ruby Client for Balihoo's LPC API
+email:
+- jd.guzman@bluewaterbrand.com
+- nic.boie@bluewaterbrand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- balihoo_lpc_client.gemspec
+- bin/console
+- bin/setup
+- lib/balihoo_lpc_client.rb
+- lib/balihoo_lpc_client/configuration.rb
+- lib/balihoo_lpc_client/connection.rb
+- lib/balihoo_lpc_client/request/api_base.rb
+- lib/balihoo_lpc_client/request/authentication.rb
+- lib/balihoo_lpc_client/request/base.rb
+- lib/balihoo_lpc_client/request/campaigns.rb
+- lib/balihoo_lpc_client/request/campaigns_with_tactics.rb
+- lib/balihoo_lpc_client/request/metrics.rb
+- lib/balihoo_lpc_client/response/authentication.rb
+- lib/balihoo_lpc_client/response/campaign.rb
+- lib/balihoo_lpc_client/response/metric.rb
+- lib/balihoo_lpc_client/response/tactic.rb
+- lib/balihoo_lpc_client/version.rb
+homepage: https://github.com/riverock/balihoo_lpc
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Client for Balihoo's LPC API
+test_files: []