adzerk 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbf807615b442c107c0adf872c51fa3d91b55044
-  data.tar.gz: c22fccc8609e2999a14f218f4a892f96eb6c98ff
+  metadata.gz: c665786700652cfe78709f0f64edb8e33a18bdc0
+  data.tar.gz: 25d623fe18b1754b64ead8d06067ed9707fc5daf
 SHA512:
-  metadata.gz: 689ca16190cb2b8880252e0d5120ddfcedecd8a463c7b1260111eb9b7bf50c7cff095a29359d6aa094c123f79e0d911c8f9cd4c34cdb01ad1bf2e55f3e85458a
-  data.tar.gz: 686c57f7c0150b20f068550f07a3bc0ab0221a3e5841cd655703dab2b34946e1b0ea5495683ea013f3c5699282bc1000d3c77f76120d4eff79cd336c147ccf0a
+  metadata.gz: 398edffd5fd4cf6e1e16bac11a7acfe9cb5958aa2c734a02bfe6dd429a431bcb48000d09821dd40a7778d8ea12c6fa99f29dfd6c2bb84733b1769394310e92ee
+  data.tar.gz: 22e1343320f3228ac3002cb96cd54630b1f714f1bafc35007d4631364ef75ace5c59c08d8ff81c604dc5c209fe6ca24895f6b97d601848973095de3d318724d0

data/lib/adzerk/reporting.rb

@@ -13,9 +13,14 @@ module Adzerk
       parse_response(client.post_request('report', data))
     end
 
-    def retrieve_report(id)
-      url = 'report/' + id
-      client.get_request(url)
+    def create_queued_report(data={})
+      data = { 'criteria' => camelize_data(data).to_json }
+      parse_response(client.post_request('report/queue', data))
+    end
+
+    def retrieve_queued_report(id)
+      url = 'report/queue/' + id
+      parse_response(client.get_request(url))
     end
   end
 end

data/lib/adzerk/version.rb

@@ -1,3 +1,3 @@
 module Adzerk
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/test/report_api_spec.rb

@@ -4,10 +4,8 @@ describe "Report API" do
 
   before do
     @reports = Adzerk::Client.new(API_KEY).reports
-  end
 
-  it "create a report" do
-    new_report = {
+    $new_report = {
       :start_date => "1/15/2011",
       :end_date => "12/31/2011",
       :group_by => ['month'],
@@ -16,16 +14,42 @@ describe "Report API" do
       :is_total => true,
       :parameters => []
     }
-    report = @reports.create_report(new_report)
-    expect(report[:is_total]).to eq(true)
-    expect(report[:grouping]).to eq(["month"])
   end
 
-  it "should pull a saved custom report" do
-    pending
-    $savedReportId = 5280
-    response = @reports.retrieve_report($savedReportId.to_s)
-    csv_report = response.body
+  it "should create a report" do
+    report = @reports.create_report($new_report)
+    expect(report.has_key? :id).to be true
+    expect(report[:is_total]).to be true
+    expect(report[:grouping]).to eq ["month"]
+  end
+
+  it "should create a queued report" do
+    response = @reports.create_queued_report($new_report)
+    $saved_report_id = response[:id]
+    expect($saved_report_id).to_not be_nil
+  end
+
+  it "should poll for the result of a queued report" do
+    response = @reports.retrieve_queued_report($saved_report_id)
+    expect(response[:id]).to eq $saved_report_id
+    expect([1,2,3]).to include response[:status]
+  end
+
+  it "should return a status of 1 if the report isn't ready yet" do
+    bigger_report = $new_report.update(start_date: "1/1/2010", end_date: "10/1/2014")
+    report_id = @reports.create_queued_report(bigger_report)[:id]
+    # immediately poll for the result
+    response = @reports.retrieve_queued_report(report_id)
+    expect(response[:status]).to eq 1
+  end
+
+  it "should retrieve a queued report if available" do
+    # use $saved_report_id from 3 tests ago, wait a couple seconds to make sure the report is ready
+    sleep 2
+    response = @reports.retrieve_queued_report($saved_report_id)
+    expect(response[:status]).to eq 2
+    expect(response[:result][:is_total]).to be true
+    expect(response[:result][:grouping]).to eq ["month"]
   end
 end
 

data/test/security_api_spec.rb

@@ -4,14 +4,14 @@ require 'net/http'
 describe "Channel API security" do
 
   it "should reject unauthenticated GET requests" do
-    uri = URI.parse(ENV['ADZERK_API_HOST'] + 'channel/')
+    uri = URI.parse(API_HOST + 'channel/')
     http = Net::HTTP.new(uri.host, uri.port)
     request = Net::HTTP::Get.new(uri.request_uri)
     expect(http.request(request).response.code).not_to eq(200)
   end
 
   it "should reject GET requests with null API keys" do
-    uri = URI.parse(ENV['ADZERK_API_HOST'] + 'channel/')
+    uri = URI.parse(API_HOST + 'channel/')
     http = Net::HTTP.new(uri.host, uri.port)
     request = Net::HTTP::Get.new(uri.request_uri)
     request.add_field "X-Adzerk-ApiKey", ""

data/test/spec_helper.rb

@@ -5,6 +5,7 @@ $:.push File.expand_path("../lib", __FILE__)
 require "adzerk"
 
 API_KEY = ENV['ADZERK_API_KEY'] || 'your_api_key'
+API_HOST = ENV["ADZERK_API_HOST"] || 'http://api.adzerk.net/v1/'
 # $adzerk = Adzerk.new(API_KEY)
 
 RSpec.configure do |config|

data/test/zone_api_spec.rb

@@ -2,7 +2,6 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Zone API" do
 
-
   before(:all) do
     @client = Adzerk::Client.new(API_KEY)
     @zones = @client.zones
@@ -49,10 +48,7 @@ describe "Zone API" do
   it "should list all zones" do
     result = @zones.list
     expect(result.length).to be > 0
-    expect(result[:items].last[:id].to_s).to eq($zone_id)
-    expect(result[:items].last[:name]).to eq($name)
-    expect(result[:items].last[:site_id]).to eq($site_id)
-    expect(result[:items].last[:is_deleted]).to eq(false)
+    expect(result[:items].any? {|zone| zone[:id].to_s == $zone_id}).to be true
   end
 
   it "should delete a new zone" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adzerk
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Kacy Fortner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -56,14 +56,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.8
 description: Ruby library for the Adzerk API
@@ -120,17 +120,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Adzerk API