yieldmanager 0.8.6 → 0.9.0

data/API_VERSION

@@ -1 +1 @@
-1.33
+1.34

data/AVAILABLE_SERVICES

@@ -0,0 +1,18 @@
+AdjustmentService
+CampaignService
+ContactService
+CreativeService
+DictionaryService
+EntityService
+InsertionOrderService
+LineItemService
+LinkingService
+NotificationService
+PixelService
+QuotaService
+ReportService
+SearchService
+SectionService
+SegmentDefinitionService
+SiteService
+TargetProfileService

data/HOW_TO_UPDATE_API_VERSION

@@ -0,0 +1,10 @@
+As of the 0.9 release, the "build" step is no longer needed. Technically, it never was, but I didn't realize that until now. :-P
+
+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
+- Bump the version 'rake version:bump:patch' unless you've made other awesome changes, in which case use 'rake version:bump:minor'
+- 'rake release' to cut a version, push to github and push to rubygems.org
+
+And you're done!

data/README.md

@@ -7,7 +7,7 @@ Currently it generates a fresh wsdl from the api.yieldmanager.com site the
 first time you use a service (in the future it will use locally-cached
 copies) and re-uses that wsdl for the life of the Yieldmanager::Client object.
 
-This version implements API version 1.33.
+The current API version is stored in the API_VERSION file.
 
 ### Installation
 
@@ -138,6 +138,30 @@ create your own reports.
 	rpt.data.first.by_name("first").should == 1
 	rpt.data.first.by_name("second").should == 2
 
+### Wiredumps (SOAP logging)
+
+To see the nitty-gritty of what's going over the wire (Yahoo tech support often asks for this),
+you can activate a "wiredump" on a per-service basis. Typically you just echo it to standard out.
+For instance:
+
+	client.entity.wiredump_dev = $stdout # on
+	adv = client.entity.get(token,12345)
+	client.entity.wiredump_dev = nil # off
+
+For Rails in a passenger environment, standard out doesn't end up in the logfiles.
+Instead, redirect to a file:
+
+	wiredump = File.new("#{Rails.root}/log/wiredump_entity_#{Time.new.strftime('%H%M%S')}.log",'w')
+	client.entity.wiredump_dev = wiredump # on
+
+	adv = client.entity.get(token,12345)
+
+	wiredump.flush # make sure everything gets in there before it closes
+	client.entity.wiredump_dev = nil # off
+
+The last 2 lines belong in an ensure block, so the file is created even
+when there's an error (which is probably why you're doing this).
+
 ### session vs. start_session/end_session
 
 The **session** method opens a session, gives you a token to use in your service
@@ -171,4 +195,4 @@ and [Tomor Doron's blog post](http://tomerdoron.blogspot.com/2009/10/fixing-soap
 
 ## Copyright
 
-Copyright (c) 2009-2011 Bill Gathen. See LICENSE for details.
+Copyright (c) 2009-2012 Bill Gathen. See LICENSE for details.

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/billgathen/yieldmanager"
     gem.authors = ["Bill Gathen"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rdoc"
     gem.add_dependency "hpricot", "= 0.8.2"
     gem.add_dependency "soap4r", "= 1.5.8"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -56,8 +57,8 @@ task :spec => :check_dependencies
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
@@ -69,13 +70,22 @@ end
 namespace :yieldmanager do
   desc "Build wsdls for API version in API_VERSION file"
   task :build_wsdls do
-    require 'lib/yieldmanager/builder'
+    require './lib/yieldmanager/builder'
     Yieldmanager::Builder.build_wsdls_for(api_version)
   end
   
   desc "Delete wsdls for API version in API_VERSION file"
   task :delete_wsdls do
-    require 'lib/yieldmanager/builder'
+    require './lib/yieldmanager/builder'
     Yieldmanager::Builder.delete_wsdls_for(api_version)
   end
 end
+
+def api_version
+  version_file = "API_VERSION"
+  path = File.join(File.dirname(__FILE__), version_file)
+  unless File.exists?(path)
+    fail "Put the API version in a file called #{version_file}"
+  end
+  File.open(path){ |f| f.readline.chomp }
+end

data/VERSION

@@ -1 +1 @@
-0.8.6
+0.9.0

data/lib/yieldmanager/client.rb

@@ -111,13 +111,20 @@ module Yieldmanager
     end
   
     def available_services
-      Dir.entries(@wsdl_dir).map do |wsdl|
-        if wsdl.match(/wsdl/) 
-          wsdl.sub(/\.wsdl/,'')
-        else
-          nil
-        end
-      end.compact
+      available_services = []
+      available_services_file = "AVAILABLE_SERVICES"
+      path = File.join(File.dirname(__FILE__), '..', '..', available_services_file)
+      unless File.exists?(path)
+        fail "Put available services in a file called #{available_services_file}"
+      end
+      IO.readlines(path).each do |line|
+        available_services << camel_to_under(line.chomp.sub(/Service$/,''))
+      end
+      available_services
+    end
+    
+    def camel_to_under s
+      s.gsub(/(.)([A-Z])/,'\1_\2').downcase
     end
     
     # Manages Yieldmanager session

data/lib/yieldmanager.rb

@@ -4,7 +4,6 @@ $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 #
 # * Yieldmanager::Client is the class used to interact with Yieldmanager.
 # * Yieldmanager::Report is the data object returned by ReportWare calls.
-# * Yieldmanager::Builder creates local copies of the YM service wsdls.
 #
 module Yieldmanager
 end
@@ -26,5 +25,4 @@ if needs_patching?(:ruby_version => RUBY_VERSION, :minimum_ruby_version_for_patc
   require 'wsdl/patch'
 end
 
-require 'yieldmanager/builder'
 require 'yieldmanager/report'

data/spec/yieldmanager/client_spec.rb

@@ -9,7 +9,7 @@ EOM
 
 describe "api version" do
   it "pulls api version from file" do
-    Yieldmanager::Client.api_version.should == "1.33"
+    Yieldmanager::Client.api_version.should match /\d\.\d{2}/
   end
 end
 

data/yieldmanager.gemspec

@@ -1,116 +1,72 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{yieldmanager}
-  s.version = "0.8.6"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Bill Gathen"]
-  s.date = %q{2011-08-03}
+  s.authors = [%q{Bill Gathen}]
+  s.date = %q{2012-01-24}
   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.email = %q{bill@billgathen.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md",
-     "TODO"
+    "README.md",
+    "TODO"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     ".rspec",
-     "API_VERSION",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "TODO",
-     "VERSION",
-     "lib/patch_detector.rb",
-     "lib/soap4r_19_patch/soap/generator.rb",
-     "lib/soap4r_19_patch/soap/property.rb",
-     "lib/soap4r_19_patch/xsd/charset.rb",
-     "lib/soap4r_19_patch/xsd/xmlparser.rb",
-     "lib/wsdl/patch.rb",
-     "lib/yieldmanager.rb",
-     "lib/yieldmanager/builder.rb",
-     "lib/yieldmanager/client.rb",
-     "lib/yieldmanager/report.rb",
-     "spec/patch_detector_spec.rb",
-     "spec/reports/sample_report.xml",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/yieldmanager/builder_spec.rb",
-     "spec/yieldmanager/client_spec.rb",
-     "spec/yieldmanager/report_spec.rb",
-     "wsdls/1.33/prod/adjustment.wsdl",
-     "wsdls/1.33/prod/campaign.wsdl",
-     "wsdls/1.33/prod/contact.wsdl",
-     "wsdls/1.33/prod/creative.wsdl",
-     "wsdls/1.33/prod/dictionary.wsdl",
-     "wsdls/1.33/prod/entity.wsdl",
-     "wsdls/1.33/prod/insertion_order.wsdl",
-     "wsdls/1.33/prod/line_item.wsdl",
-     "wsdls/1.33/prod/linking.wsdl",
-     "wsdls/1.33/prod/notification.wsdl",
-     "wsdls/1.33/prod/pixel.wsdl",
-     "wsdls/1.33/prod/placement.wsdl",
-     "wsdls/1.33/prod/quota.wsdl",
-     "wsdls/1.33/prod/report.wsdl",
-     "wsdls/1.33/prod/search.wsdl",
-     "wsdls/1.33/prod/section.wsdl",
-     "wsdls/1.33/prod/site.wsdl",
-     "wsdls/1.33/prod/target_profile.wsdl",
-     "wsdls/1.33/prod/xsd_gen.php",
-     "wsdls/1.33/test/adjustment.wsdl",
-     "wsdls/1.33/test/campaign.wsdl",
-     "wsdls/1.33/test/contact.wsdl",
-     "wsdls/1.33/test/creative.wsdl",
-     "wsdls/1.33/test/dictionary.wsdl",
-     "wsdls/1.33/test/entity.wsdl",
-     "wsdls/1.33/test/insertion_order.wsdl",
-     "wsdls/1.33/test/line_item.wsdl",
-     "wsdls/1.33/test/linking.wsdl",
-     "wsdls/1.33/test/notification.wsdl",
-     "wsdls/1.33/test/pixel.wsdl",
-     "wsdls/1.33/test/placement.wsdl",
-     "wsdls/1.33/test/quota.wsdl",
-     "wsdls/1.33/test/report.wsdl",
-     "wsdls/1.33/test/search.wsdl",
-     "wsdls/1.33/test/section.wsdl",
-     "wsdls/1.33/test/site.wsdl",
-     "wsdls/1.33/test/target_profile.wsdl",
-     "wsdls/1.33/test/xsd_gen.php",
-     "yieldmanager.gemspec"
+    ".rspec",
+    "API_VERSION",
+    "AVAILABLE_SERVICES",
+    "HOW_TO_UPDATE_API_VERSION",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "lib/patch_detector.rb",
+    "lib/soap4r_19_patch/soap/generator.rb",
+    "lib/soap4r_19_patch/soap/property.rb",
+    "lib/soap4r_19_patch/xsd/charset.rb",
+    "lib/soap4r_19_patch/xsd/xmlparser.rb",
+    "lib/wsdl/patch.rb",
+    "lib/yieldmanager.rb",
+    "lib/yieldmanager/client.rb",
+    "lib/yieldmanager/report.rb",
+    "spec/patch_detector_spec.rb",
+    "spec/reports/sample_report.xml",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/yieldmanager/client_spec.rb",
+    "spec/yieldmanager/report_spec.rb",
+    "yieldmanager.gemspec"
   ]
   s.homepage = %q{http://github.com/billgathen/yieldmanager}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Interact with RightMedia's YieldManager API and Reportware products}
-  s.test_files = [
-    "spec/patch_detector_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/yieldmanager/builder_spec.rb",
-     "spec/yieldmanager/client_spec.rb",
-     "spec/yieldmanager/report_spec.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_runtime_dependency(%q<hpricot>, ["= 0.8.2"])
       s.add_runtime_dependency(%q<soap4r>, ["= 1.5.8"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<hpricot>, ["= 0.8.2"])
       s.add_dependency(%q<soap4r>, ["= 1.5.8"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<hpricot>, ["= 0.8.2"])
     s.add_dependency(%q<soap4r>, ["= 1.5.8"])
   end

metadata

@@ -1,65 +1,75 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yieldmanager
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.9.0
   prerelease: 
-  version: 0.8.6
 platform: ruby
-authors: 
+authors:
 - Bill Gathen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153058260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.2.9
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hpricot
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153058260
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2153057440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153057440
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &2153056600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.8.2
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: soap4r
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153056600
+- !ruby/object:Gem::Dependency
+  name: soap4r
+  requirement: &2153055860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 1.5.8
   type: :runtime
-  version_requirements: *id003
-description: This gem offers full access to YieldManager's API tools (read/write) as well as ad-hoc reporting through the Reportware tool
+  prerelease: false
+  version_requirements: *2153055860
+description: This gem offers full access to YieldManager's API tools (read/write)
+  as well as ad-hoc reporting through the Reportware tool
 email: bill@billgathen.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
 - TODO
-files: 
+files:
 - .document
-- .gitignore
 - .rspec
 - API_VERSION
+- AVAILABLE_SERVICES
+- HOW_TO_UPDATE_API_VERSION
 - LICENSE
 - README.md
 - Rakefile
@@ -72,85 +82,37 @@ files:
 - lib/soap4r_19_patch/xsd/xmlparser.rb
 - lib/wsdl/patch.rb
 - lib/yieldmanager.rb
-- lib/yieldmanager/builder.rb
 - lib/yieldmanager/client.rb
 - lib/yieldmanager/report.rb
 - spec/patch_detector_spec.rb
 - spec/reports/sample_report.xml
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/yieldmanager/builder_spec.rb
 - spec/yieldmanager/client_spec.rb
 - spec/yieldmanager/report_spec.rb
-- wsdls/1.33/prod/adjustment.wsdl
-- wsdls/1.33/prod/campaign.wsdl
-- wsdls/1.33/prod/contact.wsdl
-- wsdls/1.33/prod/creative.wsdl
-- wsdls/1.33/prod/dictionary.wsdl
-- wsdls/1.33/prod/entity.wsdl
-- wsdls/1.33/prod/insertion_order.wsdl
-- wsdls/1.33/prod/line_item.wsdl
-- wsdls/1.33/prod/linking.wsdl
-- wsdls/1.33/prod/notification.wsdl
-- wsdls/1.33/prod/pixel.wsdl
-- wsdls/1.33/prod/placement.wsdl
-- wsdls/1.33/prod/quota.wsdl
-- wsdls/1.33/prod/report.wsdl
-- wsdls/1.33/prod/search.wsdl
-- wsdls/1.33/prod/section.wsdl
-- wsdls/1.33/prod/site.wsdl
-- wsdls/1.33/prod/target_profile.wsdl
-- wsdls/1.33/prod/xsd_gen.php
-- wsdls/1.33/test/adjustment.wsdl
-- wsdls/1.33/test/campaign.wsdl
-- wsdls/1.33/test/contact.wsdl
-- wsdls/1.33/test/creative.wsdl
-- wsdls/1.33/test/dictionary.wsdl
-- wsdls/1.33/test/entity.wsdl
-- wsdls/1.33/test/insertion_order.wsdl
-- wsdls/1.33/test/line_item.wsdl
-- wsdls/1.33/test/linking.wsdl
-- wsdls/1.33/test/notification.wsdl
-- wsdls/1.33/test/pixel.wsdl
-- wsdls/1.33/test/placement.wsdl
-- wsdls/1.33/test/quota.wsdl
-- wsdls/1.33/test/report.wsdl
-- wsdls/1.33/test/search.wsdl
-- wsdls/1.33/test/section.wsdl
-- wsdls/1.33/test/site.wsdl
-- wsdls/1.33/test/target_profile.wsdl
-- wsdls/1.33/test/xsd_gen.php
 - yieldmanager.gemspec
 homepage: http://github.com/billgathen/yieldmanager
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Interact with RightMedia's YieldManager API and Reportware products
-test_files: 
-- spec/patch_detector_spec.rb
-- spec/spec_helper.rb
-- spec/yieldmanager/builder_spec.rb
-- spec/yieldmanager/client_spec.rb
-- spec/yieldmanager/report_spec.rb
+test_files: []