adk2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 412d8e26fd1d32d8def4942f68b85ac6a1bec8c6
+  data.tar.gz: 4f288ad73a3e141e719fb7cab040f258705a3d02
+SHA512:
+  metadata.gz: 4cd10471bc8ef3ad54eec6fa5a3b64a39589f3d9bcbbdb4024c287079f8e7db06d676eed2bc6adb0a1bb574b36e115de6127bd41327cacb102d7244e96f12454
+  data.tar.gz: ec604ec95ee78bc218dd5d0fb454cf99096fd6e5cba1bbfb7b2a194892c68f206d9a76b6745b674fde30f023df997f40603a503fd7ec836b0f1728e4183ee595

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.envrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Helge Rausch
+
+MIT License
+
+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,55 @@
+# Adk2
+
+[![Code Climate](https://codeclimate.com/github/ad2games/adk2/badges/gpa.svg)](https://codeclimate.com/github/ad2games/adk2)
+[![Test Coverage](https://codeclimate.com/github/ad2games/adk2/badges/coverage.svg)](https://codeclimate.com/github/ad2games/adk2)
+[![Circle CI](https://circleci.com/gh/ad2games/adk2.svg?style=svg)](https://circleci.com/gh/ad2games/adk2)
+
+A ruby wrapper for accessing the ADK2 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adk2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adk2
+
+## Usage
+
+To initially generate an API token, you can use the `get_api_token` method:
+
+```ruby
+api_token = Adk2::Client.new(network_name).get_api_token(username, password)
+```
+
+To generate report, first create a new client instance:
+
+```ruby
+client = Adk2::Client.new(network_name, api_token)
+```
+
+Use the client to generate a report, e.g.:
+```ruby
+client.report(
+  'network',
+  'networkanalyticsbydate',
+  '2015-02-01',
+  '2015-02-04'
+)
+```
+
+## Contributing
+
+1. Fork it (https://github.com/ad2games/adk2/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/adk2.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adk2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adk2'
+  spec.version       = Adk2::VERSION
+  spec.authors       = ['ad2games GmbH']
+  spec.email         = ['developers@ad2games.com']
+  spec.summary       = 'API client for adk2'
+  spec.description   = 'API client for adk2'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/adk2.rb

@@ -0,0 +1,2 @@
+require 'adk2/client'
+require 'adk2/version'

data/lib/adk2/client.rb

@@ -0,0 +1,44 @@
+require 'rest-client'
+require 'csv'
+require 'json'
+
+module Adk2
+  class Client
+    def initialize(network_name, api_token = '')
+      @api_base_url = "https://#{network_name}.adk2.com"
+      @api_token = api_token
+    end
+
+    def report(level, name, start_date, end_date)
+      response = RestClient.get(
+        "#{api_base_url}/denver/reports/#{level}/#{name}/#{start_date}-#{end_date}",
+        params: {
+          fmt: 'csv',
+          auth: @api_token
+        }
+      )
+
+      CSV.parse(response, headers: true).map(&:to_h)
+    end
+
+    def get_api_token(username, password)
+      response = RestClient.post(
+        api_base_url + '/auth',
+        {
+          'email' => username,
+          'password' => password
+        }.to_json
+      )
+
+      @api_token = RestClient.post(
+        api_base_url + '/intro/profile/apikey',
+        {},
+        cookies: response.cookies
+      )
+    end
+
+    private
+
+    attr_reader :api_base_url, :api_token
+  end
+end

data/lib/adk2/version.rb

@@ -0,0 +1,3 @@
+module Adk2
+  VERSION = '0.0.1'
+end

data/spec/fixtures/vcr/Getting_a_report/gets_the_report.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://adk2-network-name.adk2.com/denver/reports/network/networkanalyticsbydate/2015-02-01-2015-02-01?auth=adk2-api-token&fmt=csv
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Headers:
+      - Authorization, origin, accept
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - X-Frames,X-Duration
+      Cache-Control:
+      - private, max-age=0, must-revalidate
+      Content-Disposition:
+      - attachment; filename=networkanalyticsbydate_2015-02-01_2015-02-01.csv
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - text/csv
+      Date:
+      - Mon, 02 Feb 2015 09:43:17 GMT
+      Server:
+      - adk2
+      Content-Length:
+      - '253'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA3WP64rCMBCF/wu+yRjmklufptQ67gZrW9JYX19NwV0XNjBk
+        vpMzc8ipKwplKt3QpuucdVnSNC4warlP+fKhnbthOHb9P+KsudexwJpOOrVr
+        0vsC/ZD6y/OaxlXz5+Ksq443hfl2HNLyrflHydM5lbdR+/n6y7VhtWz9WjL0
+        r3qHtPn1p5rd/lWvXf5K437HSO6AfEACCYLsGISd9z6CDeKiBWLjGxcBwQk5
+        eD4IG3G4HWA0TaDoKxAZCZFsBTSI0QcW8WI9V3aemZCD5VBZ0OHLgOIq1zGy
+        vBFFIMOhsSDOUKCmkUjBUxP3uwfLAxwcsAEAAA==
+    http_version: 
+  recorded_at: Mon, 02 Feb 2015 09:43:17 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr/Getting_an_API_token/updates_the_API_token.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://adk2-network-name.adk2.com/auth
+    body:
+      encoding: UTF-8
+      string: '{"email":"developers@adk2-network-name.com","password":"adk2-password"}'
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '61'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Headers:
+      - Authorization, origin, accept
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - X-Frames,X-Duration
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Mon, 02 Feb 2015 09:22:48 GMT
+      Server:
+      - adk2
+      Set-Cookie:
+      - t1=cookie_monster
+        expires=Mon, 09 Feb 2015 09:22:48 GMT; httponly; Path=/
+      Content-Length:
+      - '151'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA02NsQoCMRBEf+XYWiwsrRQrC8HCTuRYzXAGsknI3p2F+O9u
+        CB52+4aZt2/inJW23ZX2TnykVWfHIUVNARVOcJ7/+Dzdg9cnSmvOKKNXo5th
+        ZIGp6HjpRrDURrFZ0+f0Quknbcv80/TCkYcW8qJb0qqFsA/V6zAjpIyiO3ab
+        wb7p+pGEPl/PzniVxgAAAA==
+    http_version: 
+  recorded_at: Mon, 02 Feb 2015 09:22:48 GMT
+- request:
+    method: post
+    uri: https://adk2-network-name.adk2.com/intro/profile/apikey
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Cookie:
+      - Path=%2F; t1=cookie_monster
+      Content-Length:
+      - '0'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Headers:
+      - Authorization, origin, accept
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - X-Frames,X-Duration
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - text/plain
+      Date:
+      - Mon, 02 Feb 2015 09:22:48 GMT
+      Server:
+      - adk2
+      Content-Length:
+      - '52'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAO5Cz1QAA0ssyNQtyc9OzQMAIVlIPQkAAAA=
+    http_version: 
+  recorded_at: Mon, 02 Feb 2015 09:22:49 GMT
+recorded_with: VCR 2.9.3

data/spec/integration/get_api_token_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Getting an API token', :vcr do
+  it 'updates the API token' do
+    expect(Adk2::Client.new(ENV['ADK2_NETWORK_NAME'])
+      .get_api_token(ENV['ADK2_USERNAME'], ENV['ADK2_PASSWORD'])).to eq('api-token')
+  end
+end

data/spec/integration/report_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'pry'
+
+describe 'Getting a report', :vcr do
+  subject { Adk2::Client.new(ENV['ADK2_NETWORK_NAME'], ENV['ADK2_API_TOKEN']) }
+
+  it 'gets the report' do
+    report = subject.report(
+      'network',
+      'networkanalyticsbydate',
+      '2015-02-01',
+      '2015-02-01'
+    )
+
+    expect(report).to be_a(Array)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'vcr'
+require './lib/adk2'
+
+ENV['ADK2_NETWORK_NAME'] ||= 'adk2-network-name'
+ENV['ADK2_USERNAME'] ||= 'adk2-username'
+ENV['ADK2_PASSWORD'] ||= 'adk2-password'
+ENV['ADK2_API_TOKEN'] ||= 'adk2-api-key'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  config.warnings = true
+end
+
+VCR.configure do |c|
+  c.configure_rspec_metadata!
+
+  c.cassette_library_dir = 'spec/fixtures/vcr'
+  c.hook_into :webmock
+
+  c.filter_sensitive_data('adk2-network-name') { ENV['ADK2_NETWORK_NAME'] }
+  c.filter_sensitive_data('adk2-api-token') { ENV['ADK2_API_TOKEN'] }
+  c.filter_sensitive_data('adk2-username') { ENV['ADK2_USERNAME'] }
+  c.filter_sensitive_data('adk2-password') { ENV['ADK2_PASSWORD'] }
+
+  c.ignore_hosts 'codeclimate.com'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: adk2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ad2games GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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: 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: vcr
+  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'
+- !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'
+description: API client for adk2
+email:
+- developers@ad2games.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adk2.gemspec
+- lib/adk2.rb
+- lib/adk2/client.rb
+- lib/adk2/version.rb
+- spec/fixtures/vcr/Getting_a_report/gets_the_report.yml
+- spec/fixtures/vcr/Getting_an_API_token/updates_the_API_token.yml
+- spec/integration/get_api_token_spec.rb
+- spec/integration/report_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 4
+summary: API client for adk2
+test_files:
+- spec/fixtures/vcr/Getting_a_report/gets_the_report.yml
+- spec/fixtures/vcr/Getting_an_API_token/updates_the_API_token.yml
+- spec/integration/get_api_token_spec.rb
+- spec/integration/report_spec.rb
+- spec/spec_helper.rb