adk2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 412d8e26fd1d32d8def4942f68b85ac6a1bec8c6
-  data.tar.gz: 4f288ad73a3e141e719fb7cab040f258705a3d02
+  metadata.gz: 2f3424b26aa32a125d4c8a5ebf87578fb21c729d
+  data.tar.gz: 286456f416e8a6341987a82b27b00712e526ec20
 SHA512:
-  metadata.gz: 4cd10471bc8ef3ad54eec6fa5a3b64a39589f3d9bcbbdb4024c287079f8e7db06d676eed2bc6adb0a1bb574b36e115de6127bd41327cacb102d7244e96f12454
-  data.tar.gz: ec604ec95ee78bc218dd5d0fb454cf99096fd6e5cba1bbfb7b2a194892c68f206d9a76b6745b674fde30f023df997f40603a503fd7ec836b0f1728e4183ee595
+  metadata.gz: f63613b167fc19c9132ac66d7007cfd0d893fead07779ea774963e0fdff783a615fef3fc1e4c644bf48dc794bf0bcb38e5714393e91ed837457ca5c7a26fe97f
+  data.tar.gz: 7e582b3199f39c85e435968552386b38aa0ccd13b5a19919bd3825dab3048ffd0043783c923961541ecfa558ebd1bc8bde8edfb16a8190060975d31f98528acf

data/README.md

@@ -24,19 +24,24 @@ Or install it yourself as:
 
 ## Usage
 
-To initially generate an API token, you can use the `get_api_token` method:
+To instantiate the client:
 
 ```ruby
-api_token = Adk2::Client.new(network_name).get_api_token(username, password)
+client = Adk2::Client.new(network_name, username: 'foo@example.com', password: '123456')
 ```
 
-To generate report, first create a new client instance:
+Alternatively, you can use an API token:
 
 ```ruby
-client = Adk2::Client.new(network_name, api_token)
+client = Adk2::Client.new(network_name, api_token: 'tokentokentoken')
 ```
 
-Use the client to generate a report, e.g.:
+In case the API token expires (TODO: when does this happen?), with the
+first version the client automatically will fetch a new one. With the
+second version it won't.
+
+Use the client to generate a report:
+
 ```ruby
 client.report(
   'network',

data/adk2.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rest-client'
+  spec.add_dependency 'retryable'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'pry'

data/lib/adk2/client.rb

@@ -1,32 +1,36 @@
-require 'rest-client'
 require 'csv'
 require 'json'
+require 'rest-client'
+require 'retryable'
 
 module Adk2
   class Client
-    def initialize(network_name, api_token = '')
+    def initialize(network_name, opts = {})
       @api_base_url = "https://#{network_name}.adk2.com"
-      @api_token = api_token
+      @username = opts[:username]
+      @password = opts[:password]
+      @api_token = opts[: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
-        }
-      )
+    def entities(type, params = {})
+      JSON.parse(http_get(type, { rows: 1000 }.merge(params)), symbolize_names: true)[:rows]
+    end
 
+    def entity(type, id)
+      JSON.parse(http_get("#{type}/#{id}"), symbolize_names: true)
+    end
+
+    def report(level, name, start_date, end_date)
+      response = http_get("reports/#{level}/#{name}/#{start_date}-#{end_date}", fmt: 'csv')
       CSV.parse(response, headers: true).map(&:to_h)
     end
 
-    def get_api_token(username, password)
+    def get_api_token
       response = RestClient.post(
         api_base_url + '/auth',
         {
-          'email' => username,
-          'password' => password
+          'email' => @username,
+          'password' => @username
         }.to_json
       )
 
@@ -40,5 +44,16 @@ module Adk2
     private
 
     attr_reader :api_base_url, :api_token
+
+    def http_get(path, params = {})
+      Retryable.retryable(tries: 1, on: RestClient::Forbidden) do |_, exception|
+        get_api_token if exception
+
+        RestClient.get(
+          "#{api_base_url}/denver/#{path}",
+          params: { fmt: 'json', auth: @api_token }.merge(params)
+        )
+      end
+    end
   end
 end

data/lib/adk2/version.rb

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

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

@@ -2,7 +2,7 @@
 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
+    uri: https://adk2-network-name.adk2.com/denver/reports/network/networkanalyticsbydate/2014-12-01-2014-12-01?auth=adk2-api-token&fmt=csv
     body:
       encoding: US-ASCII
       string: ''
@@ -31,28 +31,30 @@ http_interactions:
       Cache-Control:
       - private, max-age=0, must-revalidate
       Content-Disposition:
-      - attachment; filename=networkanalyticsbydate_2015-02-01_2015-02-01.csv
+      - attachment; filename=networkanalyticsbydate_2014-12-01_2014-12-01.csv
       Content-Encoding:
       - gzip
       Content-Type:
       - text/csv
       Date:
-      - Mon, 02 Feb 2015 09:43:17 GMT
+      - Tue, 03 Feb 2015 16:39:44 GMT
       Server:
       - adk2
+      X-Last-Updated:
+      - '2015-02-03 16:08:32'
       Content-Length:
-      - '253'
+      - '245'
       Connection:
       - keep-alive
     body:
       encoding: ASCII-8BIT
       string: !binary |-
-        H4sIAAAAAAAAA3WP64rCMBCF/wu+yRjmklufptQ67gZrW9JYX19NwV0XNjBk
-        vpMzc8ipKwplKt3QpuucdVnSNC4warlP+fKhnbthOHb9P+KsudexwJpOOrVr
-        0vsC/ZD6y/OaxlXz5+Ksq443hfl2HNLyrflHydM5lbdR+/n6y7VhtWz9WjL0
-        r3qHtPn1p5rd/lWvXf5K437HSO6AfEACCYLsGISd9z6CDeKiBWLjGxcBwQk5
-        eD4IG3G4HWA0TaDoKxAZCZFsBTSI0QcW8WI9V3aemZCD5VBZ0OHLgOIq1zGy
-        vBFFIMOhsSDOUKCmkUjBUxP3uwfLAxwcsAEAAA==
+        H4sIAAAAAAAAA3WPa4rDMAyE/xd6EzVIlh/JaULqqrumiR0cN71+8yjd7cIa
+        bM18jCR86YpASaXr2zCMWaYppDhBlPJI+fbBrl3fnzv/Dxwle4kF5nCR1M5B
+        HhP4PvjbUlKcJX8OzjJLvAuM93Mfpm/JPySnayjvoPhx+JXa7RbZ9Vwy+PW+
+        l7R5/dO2u/1Lhy5/hXg8KCR9InVCAiJ2ennRGGBqQFU1agsIGhRgpU2D21k0
+        kyGndk2aa1XvGjWyMdRYtLT2oHIOm9pqu/DVk7LaMJM2zq3+1cZmS5OzYF6U
+        qWI26Kwyyinm4+EJY/Nz9qIBAAA=
     http_version: 
-  recorded_at: Mon, 02 Feb 2015 09:43:17 GMT
+  recorded_at: Tue, 03 Feb 2015 16:39:44 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/vcr/Getting_an_entity/gets_a_single_entity.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://adk2-network-name.adk2.com/denver/publishers/1?auth=adk2-api-token&fmt=json
+    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
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Wed, 04 Feb 2015 13:06:04 GMT
+      Server:
+      - adk2
+      Content-Length:
+      - '610'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAJ030lQAA3VRy2rDMBC89yuCjqUJtkNSyCmpz20NLb2UENbW2hboYSS5jWv879UqIekhBWNZ
+        szM7u+ORVeCxMXZgm1maZKuHGXMefO/Cne26zpov5Cyg4Bx6QkemQEODNn73Du1BgvMHDQpJVIIl
+        fizUwv6p1MawaQq1ymJw5YRlSbqaJ9k8Wc7S9SY8y4TUrgVLmnSREN9oD1V0/xxZbPpy7tkJ3ZCA
+        Rrhg5oRZI+P91bcYZ+Lg2tKAJWdvewyQcIUVCuL+NUhHGCoQkoR4BNVJ3J7PRWUUm/YUhpTmG3mQ
+        VuQfxmJ5sSOLvMjpKIqP0+2ZEV8ZLmpxa+PscZOsY75VZXp92SE3qusbaUqQ7dChVdiARk/Ma/ys
+        lNBu6bU4Dj/sj9HTcLMMPReext1f/8I/VIsu5OjwPbjH4FmDGsPCVOxM12t+CvU+bugDjfq8edCc
+        EiaWNWFyL6J+nKa7X5LfkxBuAgAA
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 13:06:04 GMT
+recorded_with: VCR 2.9.3

data/spec/integration/entity_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Getting an entity', :vcr do
+  subject do
+    Adk2::Client.new(ENV['ADK2_NETWORK_NAME'], api_token: ENV['ADK2_API_TOKEN'])
+  end
+
+  it 'gets a single entity' do
+    publisher = subject.entity('publishers', 1)
+    expect(publisher[:accountName]).to eq('Compuglobalhypermeganet')
+  end
+end

data/spec/integration/get_api_token_spec.rb

@@ -1,8 +1,15 @@
 require 'spec_helper'
 
 describe 'Getting an API token', :vcr do
+  subject do
+      Adk2::Client.new(
+        ENV['ADK2_NETWORK_NAME'],
+        username: ENV['ADK2_USERNAME'],
+        password: ENV['ADK2_PASSWORD']
+      )
+  end
+
   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')
+    expect(subject.get_api_token).to eq('api-token')
   end
 end

data/spec/integration/report_spec.rb

@@ -1,17 +1,40 @@
 require 'spec_helper'
-require 'pry'
 
 describe 'Getting a report', :vcr do
-  subject { Adk2::Client.new(ENV['ADK2_NETWORK_NAME'], ENV['ADK2_API_TOKEN']) }
+  subject do
+    Adk2::Client.new(ENV['ADK2_NETWORK_NAME'], api_token: ENV['ADK2_API_TOKEN'])
+  end
 
   it 'gets the report' do
     report = subject.report(
       'network',
       'networkanalyticsbydate',
-      '2015-02-01',
-      '2015-02-01'
+      '2014-12-01',
+      '2014-12-01'
     )
 
-    expect(report).to be_a(Array)
+    expect(report).to eq([
+      {
+        "date" => "2014-12-01",
+        "total_impressions" => "11374",
+        "network_impressions" => "11055",
+        "fallback_impressions" => "319",
+        "fallback_percent" => "2.8046",
+        "video_views" => "0",
+        "clicks" => "4",
+        "conversions" => "2",
+        "network_revenue" => "0.459000000",
+        "publisher_revenue" => "0.315172000",
+        "profit" => "0.143828000",
+        "network_ecpm" => "0.0403551960612",
+        "publisher_ecpm" => "0.0277098646035",
+        "profit_ecpm" => "0.0126453314577",
+        "vtr" => "0.0000",
+        "ctr" => "0.0352",
+        "conversion_rate" => "0.0176",
+        "click_conversion_rate" => "50.0000",
+        "margin" => "31.3350762527233"
+      }
+    ])
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
 
+require 'pry'
 require 'vcr'
 require './lib/adk2'
 
@@ -18,6 +21,13 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  config.before(:example) do
+    # The cert is invalid on my machine. So, not verifying it for now. - @tsujigiri
+    allow(RestClient::Request).to receive(:new).and_wrap_original do |method, opts|
+      method.call(opts.merge(verify_ssl: false))
+    end
+  end
+
   config.order = :random
   config.warnings = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adk2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  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
@@ -142,6 +156,8 @@ files:
 - 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/fixtures/vcr/Getting_an_entity/gets_a_single_entity.yml
+- spec/integration/entity_spec.rb
 - spec/integration/get_api_token_spec.rb
 - spec/integration/report_spec.rb
 - spec/spec_helper.rb
@@ -172,6 +188,8 @@ 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/fixtures/vcr/Getting_an_entity/gets_a_single_entity.yml
+- spec/integration/entity_spec.rb
 - spec/integration/get_api_token_spec.rb
 - spec/integration/report_spec.rb
 - spec/spec_helper.rb