@@ -1,5 +1,4 @@ == 0.1.0 2008-05-12 - * 1 major enhancement: * Converted to gem from Rails plugin @@ -24,4 +23,4 @@ March 2 * Changed name of cached_response to cached_xml_response. cached_response is better name for a public method, which might return Response object, if there's a cached_xml_response, nil otherwise. Allows loading of pages to be speeded up, with queries perhaps being triggered on demand (and then cached) or by js * January 10, 2008 - * First checkin on plugin + * First checkin of plugin History.txt @@ -1,7 +1,6 @@ +ebay_shopping successfully installed! +For more information on ebay_shopping, see http://ebayshopping.rubyforge.org -For more information on ebay_shopping, see http://ebay_shopping.rubyforge.org - -NOTE: Change this information in PostInstall.txt -You can also delete it if you don't want it. - - +If you wish to set up your ebay config info (app_id, affiliate info, etc) +using a YAML config file copy the following into a new file and load it with +EbayShopping::Request.config_params("/some/path/to/ebay.yml") PostInstall.txt @@ -70,4 +70,4 @@ CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n") PATH = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}" $hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc') $hoe.rsync_args = '-av --delete --ignore-errors' -$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue "" \ No newline at end of file +$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read + File.open(File.dirname(__FILE__) + "/../ebay.yml.tpl").read rescue "" \ No newline at end of file config/hoe.rb @@ -1,7 +1,7 @@ --- :production: :app_id: - :affiliate_partner: "9" # the affiliate provider (aka tracking partner). For Ebay's own affliaite scheme this is 9. For others see http://developer.ebay.com/DevZone/shopping/docs/Concepts/ShoppingAPI_FormatOverview.html#AffiliateURLParameters + :affiliate_partner: "9" # the affiliate provider (aka tracking partner). For Ebay's own affiliate scheme this is 9. For others see http://developer.ebay.com/DevZone/shopping/docs/Concepts/ShoppingAPI_FormatOverview.html#AffiliateURLParameters :affiliate_id: # your site's affiliate id, also known as tracking id, or PID :affiliate_shopper_id: "my_campaign" # default campaign identifier, also known (confusingly) as affiliate_user_id, or SID. Only applicable if affiliate provider is Commission Junction :default_site_id: # set the default ebay country here (for details see http://developer.ebay.com/DevZone/shopping/docs/CallRef/types/SiteCodeType.html). If this is blank, the US site (site_id=0) is used by ebay. Can be overridden on individual requests ebay.yml.tpl @@ -63,11 +63,30 @@ module EbayShopping @call_params = params end - # Get config params from YAML config file - def self.config_params(yaml_file=nil, env=nil) + # This method sets up the config params from YAML config file or a hash. + # This only needs to be done once, and so should normally be done when + # the applicaton starts (e.g. in the envirnoment file in a Rails app). + # + # The yaml file approach is designed to allow different environments + # (e.g. production, development, etc), with, potentially different values + # for each environment (if you only set the production environment, or + # don't specify the environment when supplying the file path, production) + # will be assumed (an example of the yaml file can be seen in ebay.yml.tpl + # in the script directory of this gem). + # + # To set the config params by hash just requires to pass a hash of + # key-value pairs with :app_id => "your_ebay_app_id" the only required + # one. if you supply affiliate info, this will be used when constructing + # the calls (and hence also in the URLs returned by ebay). Environments + # are ignored if a hash is supplied. + def self.config_params(yaml_file_path_or_hash=nil, env=nil) return @@config_params if @@config_params - all_params = YAML.load_file(yaml_file) - @@config_params = all_params[env] || all_params[:production] + if yaml_file_path_or_hash.is_a?(Hash) + @@config_params = yaml_file_path_or_hash + else + all_params = YAML.load_file(yaml_file_path_or_hash) + @@config_params = all_params[env] || all_params[:production] + end end # The response method instantiates a response object of appropriate class, i.e. :find_items_advanced generates FindItemsAdvancedResponse. lib/ebay_shopping.rb @@ -28,6 +28,14 @@ class TestEbayShopping < Test::Unit::TestCase EbayShopping::Request.config_params("/some/path/to/ebay.yml") end + def test_should_get_configs_from_given_hash + EbayShopping::Request.class_eval("@@config_params = nil") # reset config params + YAML.expects(:load_file).never + EbayShopping::Request.config_params({:app_id => "foo123", :affiliate_id => "456bar"}) + assert_equal "foo123", EbayShopping::Request.config_params[:app_id] + assert_equal "456bar", EbayShopping::Request.config_params[:affiliate_id] + end + def test_should_get_configs_from_yaml_config_file_and_cache_result EbayShopping::Request.class_eval("@@config_params = nil") # reset config params YAML.expects(:load_file).returns({:production => {:app_id => "foo123"}}) test/test_ebay_shopping.rb @@ -79,24 +79,23 @@ <pre class='syntax'> require 'ebay_shopping' -request = EbayShopping::Request.new(:find_items, {:query_keywords => "chevrolet camaro"}) # use "ruby-ized" version of Ebay API calls and params +request = EbayShopping::Request.new(:find_items, {:query_keywords => "chevrolet camaro"}) +# use "ruby-ized" version of Ebay API calls and params response = request.response items_for_sale = response.items items_for_sale.first.title # => "Chevrolet Camaro" -</pre> - - - items_for_sale.first.view_item_url_for_natural_search # => “http://cgi.ebay.com/Chevrolet-Camaro_W0QQitemZ290197239377QQcategoryZ6161QQcmdZViewItemQQ” +items_for_sale.first.view_item_url_for_natural_search +# => "http://cgi.ebay.com/Chevrolet-Camaro_W0QQitemZ290197239377QQcategoryZ6161QQcmdZViewItemQQ" - items_for_sale.first.gallery_url # => “http://thumbs.ebaystatic.com/pict/290197239377.jpg” +items_for_sale.first.gallery_url # => "http://thumbs.ebaystatic.com/pict/290197239377.jpg" - - items_for_sale.first.converted_current_price.to_s # => ”$38000.00” -...etc +items_for_sale.first.converted_current_price.to_s # => "$38000.00" +...etc +</pre> <h2>Demonstration of usage</h2> @@ -120,28 +119,7 @@ Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above. - The trunk repository is <code>svn://rubyforge.org/var/svn/ebay_shopping/trunk</code> for anonymous access. - - - OOOORRRR - - - You can fetch the source from either: - - - <ul> - <li>rubyforge: MISSING IN ACTION</li> - </ul> - - - TODO – You can not created a RubyForge project, OR have not run <code>rubyforge config</code> -yet to refresh your local rubyforge data with this projects’ id information. - - - When you do this, this message will magically disappear! - - - Or you can hack website/index.txt and make it all go away!! + You can fetch the source from: <ul> @@ -151,13 +129,6 @@ yet to refresh your local rubyforge data with this projects’ id informatio <pre>git clone git://github.com/ctagg/ebay_shopping.git</pre> - <h3>Build and test instructions</h3> - - -<pre>cd ebay_shopping -rake test -rake install_gem</pre> - <h2>License</h2> website/index.html @@ -32,21 +32,23 @@ h2. The basics <pre syntax="ruby"> require 'ebay_shopping' -request = EbayShopping::Request.new(:find_items, {:query_keywords => "chevrolet camaro"}) # use "ruby-ized" version of Ebay API calls and params +request = EbayShopping::Request.new(:find_items, {:query_keywords => "chevrolet camaro"}) +# use "ruby-ized" version of Ebay API calls and params response = request.response items_for_sale = response.items items_for_sale.first.title # => "Chevrolet Camaro" -</pre> -items_for_sale.first.view_item_url_for_natural_search # => "http://cgi.ebay.com/Chevrolet-Camaro_W0QQitemZ290197239377QQcategoryZ6161QQcmdZViewItemQQ" +items_for_sale.first.view_item_url_for_natural_search +# => "http://cgi.ebay.com/Chevrolet-Camaro_W0QQitemZ290197239377QQcategoryZ6161QQcmdZViewItemQQ" items_for_sale.first.gallery_url # => "http://thumbs.ebaystatic.com/pict/290197239377.jpg" items_for_sale.first.converted_current_price.to_s # => "$38000.00" ...etc +</pre> h2. Demonstration of usage @@ -62,36 +64,12 @@ h2. How to submit patches Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. -You can fetch the source from either: - -<% if rubyforge_project_id %> - -* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %> - -<pre>git clone git://rubyforge.org/ebay_shopping.git</pre> - -<% else %> - -* rubyforge: MISSING IN ACTION - -TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code> -yet to refresh your local rubyforge data with this projects' id information. - -When you do this, this message will magically disappear! - -<% end %> +You can fetch the source from: * github: "http://github.com/ctagg/ebay_shopping/tree/master":http://github.com/ctagg/ebay_shopping/tree/master <pre>git clone git://github.com/ctagg/ebay_shopping.git</pre> -h3. Build and test instructions - -<pre>cd ebay_shopping -rake test -rake install_gem</pre> - - h2. License This code is free to use under the terms of the MIT license. website/index.txt 7398d3c1a59e1254cadd952d6ceb0abb41c3e24d Chris Taggart chris@windowsxponmac.home http://github.com/ctagg/ebay_shopping/commit/8ec1f9c3242f85033efaf5efa62c0ac79a7883cc 8ec1f9c3242f85033efaf5efa62c0ac79a7883cc

2008-05-12T11:43:34-07:00

Added ability to config with simple hash. Tidied up instructions cf8c19c23e826e0fb393d3a364dc60b11e4dd9ad Chris Taggart chris@windowsxponmac.home