yieldmanager 0.9.6 → 0.9.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDAzYzI0NjQ5YmNlZmQ3ODkyYWM2ODhhMDBkMTJhNzljMjBhZTRhNw==
+  data.tar.gz: !binary |-
+    MDM3MDdmN2ViMjg0ODA1ZTk4YTdhNDI0YzViNjQ2ODFhMmFkNjZjYQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzBmZjA0ZTFjNjVmMTIwMGFjNTBkNDA3NGRkZmRlOTNhYzNiNWNjN2QzODI0
+    ODQyYWFlNjkwNGI5YjdmZjdiYzE2MWUxMjVhODVlNzYyYjRiMmUyNDMyMDJk
+    MjRkMGFhZDQ1MWFmNzUwZTAyMjU1NmE1ZmUxMDk3ZGIyOGZlZDc=
+  data.tar.gz: !binary |-
+    Y2JmNjg2Zjg5MmE3MDkyYmQyN2NiNGYxOTY3MGM2YWZjY2E3YzQ1NzMxMzU5
+    NTNkNzYxZmJhYTgwYWQ4Y2FmZTYzYmVmNGIwOGJhM2ZjNWRkNDRiOWU4MWJi
+    Y2I4ODVlOGQyMzI2MjQwYzc5ZWFiZDk0YzAzMGM0YzMxMTk1Mzc=

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0
+- jruby-19mode
+env:
+  global:
+  - secure: AO8pJu1f0xY/Evuf2G+l3v9ozwaaiNP1wiX8gbSRE2DoEuyghTlUBwQHCOUg0M6bq8gTvD8O7HeE9egUQ24c9Z1lA8Yr08A+WKwmf9i30iXdTffdonATyJ6fp6m6zpSQf0N+/ApXDKABpKJ671yLhRnaSho1/EdIauMvDze3gkg=
+  - secure: ZFxeI+npRXNbhQNIWNu1/MOl6fbNt84kD7AJF62E/LfjEVQZKohm6Zfm2pUrfAF7UWGnpb/ZYDusj3EnzazyUvfkd8Gj40XWXwjv0jvfnV3p8yUkAIbHKlEQqKWnbppMM7i0z+uAyJW1VFU/H50ZiuaPXTdB4LzJXH2crJQXnaQ=
+  - secure: A8iYjMBh3OPznTKD/rPztz3tWGBrdJzmlakf3JrTLLWfHHxCE+lHip/Z/EVvTb3ec37owNjh0W8Z8yTPkz54FM++tM/t/W/eR8c71y2V4SI6ln+0wv5Uh5WNqVYpCsAn1DiZ3W4j1LpMGKbnw5ShyV89wfefC2JV55jQorQbth8=
+  - secure: TE+/zUZh6brUT4q/oIKqgQH8P4mMPdeav+gUiRvkh5mtwX0HCPMW1Eq7+AoaxsTvksQfUbQLaObGGuQ3xn6ZkiE98lG6y1rk/3Q7keZLQ7zHDP2ucxAtRS/YBTKlcY5yVaj3oRoG4J0XGvN18YNXKB7jRb95HsIRIpSVmvbDjKA=

data/API_VERSION

@@ -1 +1 @@
-1.36
+1.37

data/AVAILABLE_SERVICES

@@ -1,8 +1,10 @@
 AdjustmentService
 AdvertiserDomainService
+BuyingTermsService
 CampaignService
 ContactService
 CreativeService
+DemandBlockListService
 DictionaryService
 EntityService
 InsertionOrderService
@@ -10,7 +12,9 @@ InventoryVisibilityControlsService
 LineItemService
 LinkingService
 NotificationService
+PassbackService
 PixelService
+PreferredTermsService
 PublisherReservePriceService
 QuotaService
 ReportService
@@ -19,5 +23,7 @@ SearchService
 SectionService
 SegmentDefinitionService
 SegmentService
+SitelistService
 SiteService
+SupplyBlocklistService
 TargetProfileService

data/HOW_TO_UPDATE_API_VERSION

@@ -4,6 +4,7 @@ When RightMedia updates their release (say, from 1.33 to 1.34), do this:
 - Edit the API_VERSION file to match the new release
 - Visit the main API doc page (https://api.yieldmanager.com/doc/) and make sure the AVAILABLE_SERVICES file exactly matches the services listed in the sidebar.
 - Run all the specs using 'rake' to ensure nothing broke
+- Commit/push changes and confirm Travis builds on all rubies we support
 - Bump the VERSION in lib/yieldmanager/version.rb appropriately
 - 'rake release' to cut a version and push to rubygems.org
 

data/README.md

@@ -1,5 +1,7 @@
 # yieldmanager
 
+[![Build Status](https://travis-ci.org/billgathen/yieldmanager.png)](https://travis-ci.org/billgathen/yieldmanager)
+
 This gem offers read/write access to [YieldManager's API tools](https://api.yieldmanager.com/doc/) and
 ad-hoc reporting through the Reportware tool.
 
@@ -134,6 +136,15 @@ crafted one from scratch. Assuming it's in a variable called
 end
 ```
 
+For large reports it may be necessary to increase the request
+timeout, which has a default value of 300 seconds. You may do
+so by passing in an additional argument to **pull_report**:
+
+```ruby
+max_wait_seconds = 600
+@ym.pull_report(token, request_xml, max_wait_seconds)
+```
+
 Column data can be accessed either by index or column name:
 
 ```ruby
@@ -218,8 +229,10 @@ wrap your logic in a begin/ensure clause and call end_session from the ensure.
 * Send me a pull request. Bonus points for topic branches.
 
 ## Thanks for contributing!
-* manlycode[https://github.com/manlycode] (Chris Rittersdorf)
-* KarateCode[https://github.com/KarateCode] (Michael Schneider)
+* [manlycode](https://github.com/manlycode)
+* [KarateCode](https://github.com/KarateCode)
+* [budnik](https://github.com/budnik) 
+* [walsh1kt](http://github.com/walsh1kt)
 
 ## Copyright
 

data/lib/yieldmanager/client.rb

@@ -171,9 +171,9 @@ module Yieldmanager
     # Pulls report from RightMedia, returned as Yieldmanager::Report
     #
     # Must be called within the context of a session
-    def pull_report token, xml
+    def pull_report token, xml, max_wait_seconds=300
       report = Yieldmanager::Report.new
-      report.pull(token, self.report, xml)
+      report.pull(token, self.report, xml, max_wait_seconds)
       report
     end
 

data/lib/yieldmanager/report.rb

@@ -33,9 +33,9 @@ module Yieldmanager
       @data = []
     end
 
-    def pull token, report, xml
+    def pull token, report, xml, max_wait_seconds
       report_token = request_report_token token, report, xml
-      report_url = retrieve_report_url token, report, report_token
+      report_url = retrieve_report_url token, report, report_token, max_wait_seconds
       retrieve_data report_url
     end
 
@@ -67,16 +67,24 @@ private
       report.requestViaXML(token,xml)
     end
 
-    def retrieve_report_url token, report, report_token
+    def retrieve_report_url token, report, report_token, max_wait_seconds
       report_url = nil
-      60.times do |secs| # Poll until report ready
+      start_time = Time.now
+
+      until over_max_time(start_time,max_wait_seconds)
         report_url = report.status(token,report_token)
         break if report_url
         pause
       end
+
+      raise "Report timed out after #{max_wait_seconds} seconds. Consider using the optional max_wait_seconds argument in the pull method." unless report_url
       report_url
     end
 
+    def over_max_time start_time, max_wait_seconds
+      Time.now.to_i - start_time.to_i > max_wait_seconds.to_i
+    end
+
     def retrieve_data url
       retries = 5
       doc = nil

data/lib/yieldmanager/version.rb

@@ -1,3 +1,3 @@
 module Yieldmanager
-  VERSION = "0.9.6"
+  VERSION = "0.9.7"
 end

data/spec/yieldmanager/client_spec.rb

@@ -133,8 +133,11 @@ describe "A new Yieldmanager client" do
       :imp_budget => 0,
       :priority => "Normal"
     }
-    lambda { @ym.session { |t| @ym.line_item.add(t,l) } }.
-      should_not raise_error(/enum_ym_numbers_difference: cannot accept ''/)
+    begin
+      @ym.session { |t| @ym.line_item.add(t,l) }
+    rescue Exception => e
+      expect(e.message).not_to match(/enum_ym_numbers_difference: cannot accept ''/)
+    end
   end
   
   describe "A Yieldmanager report" do

data/spec/yieldmanager/report_spec.rb

@@ -7,61 +7,61 @@ Please set these environment variables to match your Yieldmanager account:
 * YIELDMANAGER_CONTACT_ID (get this from the contact_id attribute in any UI-created reportware report)
 * YIELDMANAGER_IP_ADDRESS (your external IP address)
 EOM
-  
+
 describe "A Yieldmanager report request" do
 
   before(:each) do
     @ym = Yieldmanager::Client.new(login_args)
     @sample_report = File.join(File.dirname(__FILE__), '..', 'reports', 'sample_report.xml')
   end
-  
+
   it "returns report object" do
     @ym.session do |token|
       rpt = @ym.pull_report(token, request_xml)
       rpt.should be_instance_of(Yieldmanager::Report)
     end
   end
-  
+
   it "makes request and returns report token" do
     @ym.session do |token|
       rpt = Yieldmanager::Report.new
       rpt.send(:request_report_token, token, @ym.report, request_xml).should_not be_nil
     end
   end
-  
+
   it "uses report token to pull report url" do
     @ym.session do |token|
       rpt = Yieldmanager::Report.new
       report_token = rpt.send(:request_report_token, token, @ym.report, request_xml)
-      report_url = rpt.send(:retrieve_report_url, token, @ym.report, report_token)
+      report_url = rpt.send(:retrieve_report_url, token, @ym.report, report_token, 300)
       report_url.should_not be_nil
     end
   end
-  
+
   it "uses report url to pull report" do
     @ym.session do |token|
       rpt = Yieldmanager::Report.new
       report_token = rpt.send(:request_report_token, token, @ym.report, request_xml)
-      report_url = rpt.send(:retrieve_report_url, token, @ym.report, report_token)
+      report_url = rpt.send(:retrieve_report_url, token, @ym.report, report_token, 300)
 
       rpt.send(:retrieve_data, report_url)
       rpt.headers[0].should == "advertiser_name"
     end
   end
-  
+
   it "offers data as array of arrays" do
     report = Yieldmanager::Report.new
     report.send(:retrieve_data, @sample_report)
     report.data[0][0].should == "one"
   end
-  
+
   it "offers data by name" do
     report = Yieldmanager::Report.new
     report.send(:retrieve_data, @sample_report)
     report.data[0].by_name('first').should == "one"
     report.data[1].by_name(:second).should == "2"
   end
-  
+
   it "offers data as array of hashes" do
     report = Yieldmanager::Report.new
     report.send(:retrieve_data, @sample_report)
@@ -104,7 +104,31 @@ describe "A Yieldmanager report request" do
     report.stub(:pause) {} # don't make me wait
     expect{ report.send(:retrieve_data,"http://i_dont_exist.com") }.to raise_error
   end
-  
+
+  it "complains if report URL doesn't exist before retries" do
+    @ym.session do |token|
+      report = Yieldmanager::Report.new
+      Yieldmanager::Report.any_instance.stub(:status)
+      report.should_receive(:over_max_time).and_return(true)
+      report.stub(:pause) {} # don't make me wait
+      expect{ report.send(:retrieve_report_url, token, @ym.report, request_xml, 1) }.to raise_error(/Report timed out after 1 second./)
+    end
+  end
+
+  it "responds correctly when not over max time" do
+    start_time = Time.now-5
+    max_wait_seconds = 5
+    report = Yieldmanager::Report.new
+    report.send(:over_max_time, start_time, max_wait_seconds).should == false
+  end
+
+  it "responds correctly when over max time" do
+    start_time = Time.now-6
+    max_wait_seconds = 5
+    report = Yieldmanager::Report.new
+    report.send(:over_max_time, start_time, max_wait_seconds).should == true
+  end
+
   def login_args
     unless ENV["YIELDMANAGER_USER"] &&
       ENV["YIELDMANAGER_PASS"]

data/yieldmanager.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/billgathen/yieldmanager"
   s.summary     = %q{YieldManager API Tool}
   s.description = %q{This gem offers full access to YieldManager's API tools (read/write) as well as ad-hoc reporting through the Reportware tool}
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: yieldmanager
 version: !ruby/object:Gem::Version
-  version: 0.9.6
-  prerelease: 
+  version: 0.9.7
 platform: ruby
 authors:
 - Bill Gathen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: soap4r
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -103,11 +92,11 @@ files:
 - .gitignore
 - .rspec
 - .ruby-version
+- .travis.yml
 - API_VERSION
 - AVAILABLE_SERVICES
 - Gemfile
 - HOW_TO_UPDATE_API_VERSION
-- LICENSE
 - README.md
 - Rakefile
 - TODO
@@ -132,34 +121,28 @@ files:
 - spec/yieldmanager/report_spec.rb
 - yieldmanager.gemspec
 homepage: http://github.com/billgathen/yieldmanager
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1212190755149832978
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1212190755149832978
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: YieldManager API Tool
 test_files:
 - spec/patch_detector_spec.rb

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Bill Gathen
-
-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.