yieldmanager 0.8.4 → 0.8.5

data/{README.rdoc → README.md}

@@ -1,29 +1,33 @@
-= yieldmanager
+# yieldmanager
 
-This gem offers read/write access to YieldManager's API tools and
+This gem offers read/write access to [YieldManager's API tools](https://api.yieldmanager.com/doc/) and
 ad-hoc reporting through the Reportware tool.
 
 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
+This version implements API version 1.33.
 
-=== Installation
+### Installation
 
-Yieldmanager is available as a gem on gemcutter.org.
+Yieldmanager is available as a gem for easy installation.
 
 	sudo gem install yieldmanager
 
-The project is available for review/forking on github.com
+or if you're using [RVM](https://rvm.beginrescueend.com/) (and why on earth wouldn't you?)
 
+	gem install yieldmanager
+  
+The project is available for review/forking on github.com
+  
 	git clone git://github.com/billgathen/yieldmanager.git
 
 To use in a Rails project, add this to config/environment.rb:
 
 	config.gem 'yieldmanager'
 
-=== Creating a Yieldmanager::Client
+### Creating a Yieldmanager::Client
 
 	require 'yieldmanager'
 	
@@ -41,36 +45,38 @@ To access the test environment, use this:
 		:env => "test"
 	)
 
-The keys can also be passed as string: 'user', 'pass' and 'env'.
+The keys can also be passed as strings: 'user', 'pass' and 'env'.
 
-*NOTE* Changing the environment after creation has no effect!
+**NOTE** Changing the environment after creation has no effect!
 
-=== What API version am I using?
+### What API version am I using?
 
 To check (or log) the current API version, execute the following:
 
-  Yieldmanager::Client.api_version
+	Yieldmanager::Client.api_version
 
-=== Finding available services
+### Finding available services
 
 	@ym.available_services
 
-=== Using a service
+### Using a service
 
 	@ym.session do |token|
 		@currencies = @ym.dictionary.getCurrencies(token)
 	end
 
-*GOTCHA* In projects with ActiveRecord enabled (i.e., Rails projects)
+**GOTCHA** In projects with ActiveRecord enabled (i.e., Rails projects)
 SOAP will identify returned data as AR objects if there's a
 naming collision. For example, if you're running
+
 	@ym.creative.get(token,123)
-and you have an AR objects for a +creatives+ table in the db, the
+
+and you have an AR objects for a **creatives** table in the db, the
 SOAP parser will interpret the returned SOAP object as
 an AR Creative object, resulting in bizarre errors. Uniquely
 re-name your AR object to eliminate the conflict.	
 	
-=== Pagination
+### Pagination
 
 Some calls return datasets too large to retrieve all at once.
 Pagination allows you to pull them back incrementally, handling
@@ -87,12 +93,12 @@ the partial dataset on-the-fly or accumulating it for later use.
 	end
 
 
-=== Pulling reports
+### Pulling reports
 
 Accessing reportware assumes you've used the "Get request XML"
 functionality in the UI to get your request XML, or have
 crafted one from scratch. Assuming it's in a variable called
-*request_xml*, you'd access the data this way:
+**request_xml**, you'd access the data this way:
 
 	@ym.session do |token|
 		report = @ym.pull_report(token, request_xml)
@@ -109,59 +115,60 @@ Column data can be accessed either by index or column name:
 	report.data[0].by_name('advertiser_name') # => "Bob's Ads"
 	report.data[0].by_name(:advertiser_name) # => "Bob's Ads"
 
-If you call *by_name* with a non-existent column, it will throw an
-*ArgumentError* telling you so.
+If you call **by_name** with a non-existent column, it will throw an
+**ArgumentError** telling you so.
 
 Or you can extract the report to an array of named hashes, removing
 dependencies on the gem for consumers of the data (say, across an API):
 
-  hashes = report.to_hashes
-  hashes[0]['advertiser_name'] # => "Bob's Ads"
+	hashes = report.to_hashes
+	hashes[0]['advertiser_name'] # => "Bob's Ads"
 
-*NOTE* Any totals columns your xml requests will be interpreted
+**NOTE** Any totals columns your xml requests will be interpreted
 as ordinary data.
 
-=== Mocking reports
+### Mocking reports
 
 When simulating report calls without actually hitting Yieldmanager, you can
 create your own reports.
 
-  rpt = Yieldmanager::Report.new
-  rpt.headers = ["first","second"]
-  rpt.add_row([1,2])
-  rpt.data.first.by_name("first").should == 1
-  rpt.data.first.by_name("second").should == 2
+	rpt = Yieldmanager::Report.new
+	rpt.headers = ["first","second"]
+	rpt.add_row([1,2])
+	rpt.data.first.by_name("first").should == 1
+	rpt.data.first.by_name("second").should == 2
 
-=== session vs. start_session/end_session
+### session vs. start_session/end_session
 
-The *session* method opens a session, gives you a token to use in your service
+The **session** method opens a session, gives you a token to use in your service
 calls, then closes the session when the block ends, even if an exception is
 raised during processing. It's the recommended method to ensure you don't
 hang connections when things go wrong. If you use start/end, make sure you
 wrap your logic in a begin/ensure clause and call end_session from the ensure.
 
-== RE: Ruby 1.9
+## RE: Ruby 1.9
 
 In an effort to be a good ruby citizen, KarateCode and I have made the gem
-1.9 compatible, but it is based on soap4r 1.5.8, which generates some warnings
-in 1.9. Until a newer version of soap4r is released, you may see some of these
-warnings at runtime. Rest assured I'll upgrade as soon as soap4r does.
+1.9 compatible, but it is based on soap4r 1.5.8, which requires a pile of monkey-patches
+to get working and not **every** combination of calls and args have been tested
+in 1.9. If you're interested in what's been done, check out **lib/soap4r_19_patch**
+and [Tomor Doron's blog post](http://tomerdoron.blogspot.com/2009/10/fixing-soap4r-for-ruby-19.html).
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
+* Add specs for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but
   bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Thanks for contributing!
+## Thanks for contributing!
 * manlycode[https://github.com/manlycode] (Chris Rittersdorf)
 * KarateCode[https://github.com/KarateCode] (Michael Schneider)
 
-== Copyright
+## Copyright
 
 Copyright (c) 2009-2011 Bill Gathen. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.8.5

data/lib/soap4r_19_patch/soap/property.rb

@@ -325,16 +325,16 @@ end
 end
 
 
-# for ruby/1.6.
-unless Enumerable.instance_methods.include?('inject')
-  module Enumerable
-    def inject(init)
-      result = init
-      each do |item|
-	result = yield(result, item)
-      end
-      result
-    end
-  end
-end
+## for ruby/1.6.
+#unless Enumerable.instance_methods.include?('inject')
+#  module Enumerable
+#    def inject(init)
+#      result = init
+#      each do |item|
+#	result = yield(result, item)
+#      end
+#      result
+#    end
+#  end
+#end
 

data/yieldmanager.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yieldmanager}
-  s.version = "0.8.4"
+  s.version = "0.8.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bill Gathen"]
-  s.date = %q{2011-06-16}
+  s.date = %q{2011-08-03}
   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.rdoc",
+     "README.md",
      "TODO"
   ]
   s.files = [
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
      ".rspec",
      "API_VERSION",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "TODO",
      "VERSION",

metadata

@@ -2,7 +2,7 @@
 name: yieldmanager
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors: 
 - Bill Gathen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 Z
+date: 2011-08-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -42,7 +42,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 - TODO
 files: 
 - .document
@@ -50,7 +50,7 @@ files:
 - .rspec
 - API_VERSION
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - TODO
 - VERSION