appnexusapi 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abcd460b5e9565ea41c0960fdf71ad3f8a082878
-  data.tar.gz: e2bca3f9ae62267d8dd7bad5a023fc8a399c1839
+  metadata.gz: 0184db6bca5286e5ec3ac206cf0d964ce78484e0
+  data.tar.gz: dec7fe42720c2c0b89dcaa55bbb142bfce2721b5
 SHA512:
-  metadata.gz: 4fc78be7f3583ee7476ebdbabeed39739a4018617f2ac126e7733fb83c1a12d9ee19eb679218ddea7c9400041995f206bd5b4ce3ba02d8c9939e02b0d311cee4
-  data.tar.gz: 8e3c2db20e52f89b720c82758ef55567806f5d8a542f111bafcc3355053f8fc5b1102b76cf4e2da4b459a3c816942171e009e89b4a413cf03b5b5004b6146490
+  metadata.gz: fb39def781471b2b91f8803116d0c71d734dca49ddaca2fec95e6d104b1f7e21c61aa9c0d55fa11300a69d6d95e7e961a7479dc34ef319a8791e9032483f5aa4
+  data.tar.gz: 6932d3ac84d2f075c5cb71c4d5a97a0a618ed2af94b7f41091f2776dff59c82099527a8ac6b2c319d9577c61f6725b1f7a322e115f24fbd1e3b76686dfe49535

data/README.md

@@ -27,9 +27,9 @@ Establish a connection:
 
       # Defaults to connecting to https://api.appnexus.com/ but you can optionally pass a uri to
       # connect to another endpoint, e.g. the staging site could be
-      # uri: 'http://api.sand-08.adnxs.net
+      # "uri" => 'http://api-test.appnexus.com',
+
 
-      
     )
 
 Use a Service:
@@ -40,7 +40,27 @@ Use a Service:
     # and returns an AppnexusApi::Resource object which is a wrapper around the JSON
     member = member_service.get.first
 
-    creative_service = AppnexusApi::CreativeService.new(connection, member.id)
+    line_item_service = AppnexusApi::LineItemService.new(connection)
+    line_item = line_item_service.get.first
+    line_item = line_item_service.get({advertiser_id: 12345}).first
+
+    # create a new object
+    url_params  = { advertiser_id: 12345 }
+    body_params = { name: "some line item", code: "line item code"}
+
+    line_item = line_item_service.create(url_params, body_params)
+    line_item.state
+
+
+    # update an object
+    update_params = { state: "inactive" }
+    json_result = line_item.update(url_params, update_params)
+
+    # delete an object
+    line_item.delete(url_params)
+
+    # this raises an AppnexusApi::UnprocessableEntity, not a 404 as it should
+    line_item_service.get(line_item.id)
 
     new_creative = {
       "content"   => "<iframe src='helloword.html'></iframe>",
@@ -53,13 +73,22 @@ Use a Service:
 
 ## Testing
 
-There is a rudimentary test suite that centers around creatives/creative_service.  To use it, you'll need to copy the `env_example` file to `.env` and replace the values with your correct values for your account. After that, a simple `bundle exec rspec spec` will run the test suite
+### Running Existing Specs
+```
+bundle exec rspec
+```
+
+### Writing New Specs or Updating Old Ones
+This library uses [VCR](https://github.com/vcr/vcr) and Webmock to record API call HTTP data and play it back when you run the specs.  To write new specs or update old ones, however, you will need to actually provide a valid login/password in a `.env` file (see [`env_example`](env_example) for an example) before launching the specs.
+
+To update a spec, simply remove the relevant file from [spec/fixtures/vcr](spec/fixtures/vcr) (and setup the username/password) before launching `rspec`; the changes will be recorded automatically by VCR.
 
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make changes (with tests -- at least integration tests, please)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/UPGRADING.md

@@ -0,0 +1,10 @@
+Upgrading from 0.1.x or earlier
+
+ - create/update/delete methods now take an additional argument to pass, e.g.
+    "?publisher_id=5" where appropriate and required.  This goes before the
+    "body" hash.
+
+
+the implementation should probably read advertiser_id/publisher_id from
+the object for update/delete but in the cases that both are present, I'm
+unsure which one (or both?) should be sent

data/appnexusapi.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'dotenv'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
 end

data/env_example

@@ -1,5 +1,3 @@
-APPNEXUS_MEMBER_ID=123
 APPNEXUS_USERNAME=appnexus_user
 APPNEXUS_PASSWORD=HGsgwDdxDVWM
-APPNEXUS_URI=https://sand.api.adnxs.com
-
+APPNEXUS_URI=https://api-test.appnexus.com

data/lib/appnexusapi/advertiser_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::AdvertiserResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/advertiser_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::AdvertiserService < AppnexusApi::Service
+end

data/lib/appnexusapi/campaign_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::CampaignResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/campaign_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::CampaignService < AppnexusApi::Service
+end

data/lib/appnexusapi/connection.rb

@@ -6,7 +6,7 @@ class AppnexusApi::Connection
   RATE_EXCEEDED_DEFAULT_TIMEOUT = 15
   # Inexplicably, sandbox uses the correct code of 429, while production uses 405? so
   # we just rely on the error message
-  RATE_EXCEEDED_ERROR = "RATE_EXCEEDED".freeze
+  RATE_EXCEEDED_ERROR = 'RATE_EXCEEDED'.freeze
 
   def initialize(config)
     @config = config
@@ -44,7 +44,11 @@ class AppnexusApi::Connection
 
   def get(route, params={}, headers={})
     params = params.delete_if {|key, value| value.nil? }
-    run_request(:get, @connection.build_url(route, params), nil, headers)
+    run_request(:get, build_url(route, params), nil, headers)
+  end
+
+  def build_url(route, params)
+    @connection.build_url(route, params)
   end
 
   def post(route, body=nil, headers={})
@@ -60,16 +64,17 @@ class AppnexusApi::Connection
   end
 
   def run_request(method, route, body, headers)
-    login if !is_authorized?
+    login unless is_authorized?
     response = {}
     begin
       loop do
-        response = @connection.run_request(
+        response = run_request_only(
           method,
           route,
           body,
           { 'Authorization' => @token }.merge(headers)
         )
+        break if response.body.empty? # Log level data download service returns a body of ""
         break unless response.body.fetch('response', {})['error_code'] == RATE_EXCEEDED_ERROR
         wait_time = response.headers['retry-after'] || RATE_EXCEEDED_DEFAULT_TIMEOUT
         log.info("received rate exceeded.  wait time: #{wait_time}s")
@@ -81,7 +86,7 @@ class AppnexusApi::Connection
       else
         @retry = true
         logout
-        run_request(method, route, body, headers)
+        response = run_request(method, route, body, headers)
       end
     rescue Faraday::Error::TimeoutError => _e
       raise AppnexusApi::Timeout, 'Timeout'
@@ -91,4 +96,13 @@ class AppnexusApi::Connection
     log.debug(response.body)
     response
   end
+
+  def run_request_only(method, route, body, headers)
+    @connection.run_request(
+      method,
+      route,
+      body,
+      { 'Authorization' => @token }.merge(headers)
+    )
+  end
 end

data/lib/appnexusapi/content_category_service.rb

@@ -1,7 +1,6 @@
 class AppnexusApi::ContentCategoryService < AppnexusApi::Service
 
   def initialize(connection)
-    @read_only = true
     super(connection)
   end
 
@@ -9,4 +8,7 @@ class AppnexusApi::ContentCategoryService < AppnexusApi::Service
     "content_categories"
   end
 
+  def plural_uri_name
+    "content-categories"
+  end
 end

data/lib/appnexusapi/creative_service.rb

@@ -1,12 +1,2 @@
 class AppnexusApi::CreativeService < AppnexusApi::Service
-
-  def initialize(connection, member_id)
-    @member_id = member_id
-    super(connection)
-  end
-
-  def uri_suffix
-    "#{super}/#{@member_id}"
-  end
-
 end

data/lib/appnexusapi/payment_rule_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::PaymentRuleResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/payment_rule_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::PaymentRuleService < AppnexusApi::Service
+end

data/lib/appnexusapi/placement_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::PlacementResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/placement_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::PlacementService < AppnexusApi::Service
+end

data/lib/appnexusapi/profile_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::ProfileResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/profile_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::ProfileService < AppnexusApi::Service
+end

data/lib/appnexusapi/publisher_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::PublisherResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/publisher_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::PublisherService < AppnexusApi::Service
+end

data/lib/appnexusapi/resource.rb

@@ -8,13 +8,14 @@ class AppnexusApi::Resource
     @dbg_info = dbg_info
   end
 
-  def update(attributes={})
-    resource = @service.update(id, attributes)
+  def update(route_params={}, body_params={})
+    resource = @service.update(id, route_params, body_params)
     @json = resource.raw_json
+    self
   end
 
-  def delete
-    @service.delete(id)
+  def delete(route_params={})
+    @service.delete(id, route_params)
   end
 
   def raw_json

data/lib/appnexusapi/service.rb

@@ -61,10 +61,11 @@ class AppnexusApi::Service
     responses
   end
 
-  def create(attributes={})
+  def create(route_params={}, body={})
     raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    attributes = { name => attributes }
-    response = @connection.post(uri_suffix, attributes).body['response']
+    body = { uri_name => body }
+    route = @connection.build_url(uri_suffix, route_params)
+    response = @connection.post(route, body).body['response']
     if response['error_id']
       response.delete('dbg')
       raise AppnexusApi::BadRequest.new(response.inspect)
@@ -72,10 +73,11 @@ class AppnexusApi::Service
     parse_response(response).first
   end
 
-  def update(id, attributes={})
+  def update(id, route_params={}, body={})
     raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    attributes = { name => attributes }
-    response = @connection.put([uri_suffix, id].join('/'), attributes).body['response']
+    body = { uri_name => body }
+    route = @connection.build_url(uri_suffix, route_params.merge("id" => id))
+    response = @connection.put(route, body).body['response']
     if response['error_id']
       response.delete('dbg')
       raise AppnexusApi::BadRequest.new(response.inspect)
@@ -83,9 +85,15 @@ class AppnexusApi::Service
     parse_response(response).first
   end
 
-  def delete(id)
+  def delete(id, route_params)
     raise(AppnexusApi::NotImplemented, "Service is read-only.") if @read_only
-    @connection.delete([uri_suffix, id].join('/')).body['response']
+    route = @connection.build_url(uri_suffix, route_params.merge("id" => id))
+    response = @connection.delete(route).body['response']
+    if response['error_id']
+      response.delete('dbg')
+      raise AppnexusApi::BadRequest.new(response.inspect)
+    end
+    response
   end
 
   def parse_response(response)

data/lib/appnexusapi/site_resource.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::SiteResource < AppnexusApi::Resource
+end

data/lib/appnexusapi/site_service.rb

@@ -0,0 +1,2 @@
+class AppnexusApi::SiteService < AppnexusApi::Service
+end

data/lib/appnexusapi/version.rb

@@ -1,3 +1,3 @@
 module AppnexusApi
-  VERSION = '0.1.3'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/connection_spec.rb

@@ -1,11 +1,21 @@
 require 'spec_helper'
 
 describe AppnexusApi::Connection do
+  subject { AppnexusApi::Connection.new({}) }
 
   it 'allows no logger to be specified' do
-    expect do
-      AppnexusApi::CreativeService.new(connection_with_null_logger, ENV['APPNEXUS_MEMBER_ID'])
-    end.to_not raise_error
+    expect { AppnexusApi::CreativeService.new(connection_with_null_logger) }.to_not raise_error
   end
 
+  it 'returns data from expiration' do
+    #stub to raise error the first time and then return []
+    counter = 0
+    allow(subject).to receive(:login)
+    allow(subject).to receive(:run_request_only) do |arg|
+      counter += 1
+      raise AppnexusApi::Unauthorized.new if counter == 1
+      Faraday::Response.new(body: { not_an_error: 1 })
+    end
+    expect(subject.run_request(:get, 'http://localhost', nil, {})).not_to eq({})
+  end
 end

data/spec/creative_service_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe AppnexusApi::CreativeService do
-  let(:creative_service) do
-    AppnexusApi::CreativeService.new(connection, ENV['APPNEXUS_MEMBER_ID'])
-  end
+  include_context 'with an advertiser'
+
+  let(:creative_service) { described_class.new(connection) }
   let(:new_creative) do
     {
-      'campaign'  => 'default campaign',
+      'name'      => 'rspec test creative',
       'content'   => '<iframe src="helloword.html"></iframe>',
       'width'     => '300',
       'height'    => '250',
@@ -26,46 +26,57 @@ describe AppnexusApi::CreativeService do
         threads = []
         10.times do
           threads << Thread.new do
-            creative = creative_service.create(new_creative)
+            creative = creative_service.create(advertiser_url_params, new_creative)
             puts creative.dbg_info
           end
         end
         threads.map(&:join)
       end
     end.to_not raise_error
+
+    advertiser.delete
   end
 
   it 'supports a get operation' do
-    expect do
-      creative_service.get('start_element' => 0, 'num_elements' => 1)
-    end.to_not raise_error
+    VCR.use_cassette('creative_service_get') do
+      expect { creative_service.get('start_element' => 0, 'num_elements' => 1) }.to_not raise_error
+      advertiser.delete
+    end
   end
 
   context 'creating a new creative' do
     it 'supports creating a new creative' do
-      creative = creative_service.create(new_creative)
-      expect(creative.width).to eq 300
-      expect(creative.height).to eq 250
+      VCR.use_cassette('creative_service_create') do
+        creative = creative_service.create(advertiser_url_params, new_creative)
+        expect(creative.width).to eq(300)
+        expect(creative.height).to eq(250)
+        advertiser.delete
+      end
     end
   end
 
   context 'an existing creative' do
-    let(:existing_creative) { creative_service.create(new_creative) }
+    let(:existing_creative) { creative_service.create(advertiser_url_params, new_creative) }
 
     it 'supports changing attributes with the update action' do
-      expect(existing_creative.campaign).to eq 'default campaign'
-      existing_creative.update('campaign' => 'My Best Campaign Yet')
-      expect(existing_creative.campaign).to eq 'My Best Campaign Yet'
+      VCR.use_cassette('creative_service_update') do
+        expect(existing_creative.code).to be_nil
+        existing_creative.update(advertiser_url_params, code: "abc")
+        expect(existing_creative.code).to eq "abc"
+        advertiser.delete
+      end
     end
 
     it 'supports removing the creative' do
-      id = existing_creative.id
-      creative = creative_service.get('id' => id).first
-      expect(creative.id).to eq id
-      existing_creative.delete
-      creative = creative_service.get('id' => id)
-      expect(creative).to be_nil
+      VCR.use_cassette('creative_service_delete') do
+        id = existing_creative.id
+        creative = creative_service.get('id' => id).first
+        expect(creative.id).to eq id
+        existing_creative.delete(advertiser_url_params)
+        creative = creative_service.get('id' => id)
+        expect(creative).to be_nil
+        advertiser.delete
+      end
     end
   end
 end
-