wine_dot_com_api_request 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Christopher Meiklejohn
+
+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.

data/Manifest

@@ -0,0 +1,9 @@
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+init.rb
+lib/wine_dot_com_api_request.rb
+lib/wine_dot_com_api_request/configuration.rb
+test/wine_dot_com_api_request_test.rb
+wine_dot_com_api_request.gemspec

data/README.rdoc

@@ -0,0 +1,75 @@
+= Introduction 
+
+WineDotComApiRequest provides a simple no-frills interface to the Wine.com query API.
+  
+Its purpose is to eliminate the code duplication in setting up the request each time
+you which to receive information from the API.
+
+It returns pure JSON or XML depending on which type of response you request.
+
+= Installation
+
+To install, run:
+
+  $ sudo gem install wine_dot_com_api_request
+
+Then, place your API key from wine.com in the lib/wine_dot_com_api_request/configuration.rb file.
+
+= Examples
+
+To perform a request, follow the example below:
+
+  w = WineDotComApiRequest.new(:search => 'mondavi cabernet',
+                               :format => :xml,
+                               :resource => :catalog,
+                               :size => 1,
+                               :offset => 0)
+
+  res = w.query
+
+View the documentation for possible search arguments.
+
+The query routine will return either the raw XML or JSON request, depending on which you specify.
+
+= Documentation
+
+You can generate documentation if you have the source by typing:
+
+  $ rake doc
+
+= Release Notes
+
+First release.
+
+= Credits
+
+WineDotComApiRequest is maintained by {Christopher Meiklejohn}[mailto:cmeik@me.com].  Contact me if you'd like to request any features or have any questions or feedback.
+
+= License
+
+WineDotComApiRequest is Copyright 2010 Christopher Meiklejohn.  
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file, which is attached below:
+  
+  Copyright (c) 2010 Christopher Meiklejohn
+
+  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.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('wine_dot_com_api_request', '0.1.0') do |p|
+  p.description    = "Provides an interface to the wine.com API."
+  p.url            = "https://github.com/cmeiklejohn/wine_dot_com_api_request"
+  p.author         = "Christopher Meiklejohn"
+  p.email          = "cmeik@me.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/init.rb

@@ -0,0 +1 @@
+require 'wine_dot_com_api_request'

data/lib/wine_dot_com_api_request.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/ruby
+
+# WineDotComApiRequest class.  
+#
+# Provides an interface to access the Wine.com API.
+# 
+# Author:: Christopher Meiklejohn (cmeik@me.com)
+# Copyright:: Copyright (c) 2010 Christopher Meiklejohn
+# License:: Distributes under the terms specified in the MIT-LICENSE file.
+#
+# Usage example: 
+#w = WineDotComApiRequest.new(:search => 'mondavi cabernet',
+#                             :format => :xml,
+#                             :resource => :catalog,
+#                             :size => 1,
+#                             :offset => 0)
+#
+# w.query
+#
+# To-do: 
+# * Build a better interface for filters 
+# * Build a better interface for sortBy
+# * Implement affiliateId
+# * Implement version, beta currently only supported
+# * Extract out api key and base url into configuration parameters
+#
+# See: http://api.wine.com/wiki/2-catalog-queries
+require "wine_dot_com_api_request/configuration"
+require 'net/http'
+require 'uri'
+
+class WineDotComApiRequest
+  public
+    # API key from Wine.com.
+    attr_accessor         :api_key
+    
+    # API version number.  Available API versions: v1.0, v2.3.
+    attr_accessor         :version
+    
+    # API result format.  Available API formats: xml, json.
+    attr_accessor         :format
+    
+    # API requested resource.  Available API resources: catalog, reference, categorymap.
+    attr_accessor         :resource
+    
+    # API parameters. 
+    attr_accessor         :parameters
+    
+    # Base URL of API.
+    attr_accessor         :base_url
+    
+    # Affiliate ID for revenue sharing.
+    attr_accessor         :affiliate_id
+
+    # Search offset to start at.
+    attr_accessor         :offset
+    
+    # Number of records to return.
+    attr_accessor         :size
+    
+    # Search terms.
+    attr_accessor         :search
+    
+    # Search filter.  Ex. filter=categories(7155+124)+rating(85|100).
+    attr_accessor         :filter
+    
+    # Ship to state.  Two letter abbrev.  Ex. MA.
+    attr_accessor         :state
+    
+    # Sort key.  Ex. sort=rating|ascending.
+    attr_accessor         :sort
+    
+    # In stock.  Boolean search value.
+    attr_accessor         :instock
+
+    # Inialize the required parameters, and setup the request defaults.
+    def initialize(options = {})
+      options.each_pair do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    # Return URL that request will be made to.  Mainly for debugging purposes.
+    def url
+      api_url
+    end
+    
+    # Execute a search.  Returns either raw json or xml.
+    def query(options = {})
+      options.each_pair do |key, value|
+        self.send("#{key}=", value)
+      end
+      
+      raise 'No API base URL provided.' unless @@base_url
+      raise 'No API key provided.' unless @@api_key
+      raise 'No resource specified.' unless @resource
+      raise 'No format specified.' unless @format
+      
+      return do_get
+    end
+
+  private
+    # Perform GET request and return results.
+    def do_get
+      Net::HTTP.get(URI.parse(api_url))
+    end
+  
+    # Generate the url to make the API call to.
+    def api_url
+      "#{@@base_url}/#{format}/#{resource}?apikey=#{@@api_key}#{parameters}"
+    end
+
+    # parameters overrides attribute reader and returns custom results based on resource type.
+    def parameters
+      url_params = ""
+
+      if @resource == :catalog
+        url_params += "&" + "offset=#{URI.escape(@offset.to_s)}"   if @offset
+        url_params += "&" + "size=#{URI.escape(@size.to_s)}"       if @size
+        url_params += "&" + "search=#{URI.escape(@search)}"        if @search
+        url_params += "&" + "filter=#{URI.escape(@filter)}"        if @filter
+        url_params += "&" + "state=#{URI.escape(@state)}"          if @state
+        url_params += "&" + "sort=#{URI.escape(@sort)}"            if @sort
+        url_params += "&" + "instock=#{@instock}"                  if @instock
+      elsif @resource == :categorymap
+        url_params += "&" + "filter=#{URI.escape(@filter)}"        if @filter
+        url_params += "&" + "search=#{URI.escape(@search)}"        if @search
+      elsif @resource == :reference
+        url_params += "&" + "filter=#{URI.escape(@filter)}"        if @filter
+      end
+
+      return url_params
+    end
+end

data/lib/wine_dot_com_api_request/configuration.rb

@@ -0,0 +1,4 @@
+class WineDotComApiRequest
+  @@api_key     = '3scale-0cef67842d4f32bc31230883e1f4f69c'
+  @@base_url    = 'http://services.wine.com/api/beta/service.svc'
+end

data/test/wine_dot_com_api_request_test.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'lib/wine_dot_com_api_request'

data/wine_dot_com_api_request.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wine_dot_com_api_request}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher Meiklejohn"]
+  s.date = %q{2010-01-02}
+  s.description = %q{Provides an interface to the wine.com API.}
+  s.email = %q{cmeik@me.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/wine_dot_com_api_request.rb", "lib/wine_dot_com_api_request/configuration.rb"]
+  s.files = ["MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/wine_dot_com_api_request.rb", "lib/wine_dot_com_api_request/configuration.rb", "test/wine_dot_com_api_request_test.rb", "wine_dot_com_api_request.gemspec"]
+  s.homepage = %q{https://github.com/cmeiklejohn/wine_dot_com_api_request}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wine_dot_com_api_request", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{wine_dot_com_api_request}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Provides an interface to the wine.com API.}
+  s.test_files = ["test/wine_dot_com_api_request_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: wine_dot_com_api_request
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christopher Meiklejohn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Provides an interface to the wine.com API.
+email: cmeik@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/wine_dot_com_api_request.rb
+- lib/wine_dot_com_api_request/configuration.rb
+files: 
+- MIT-LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/wine_dot_com_api_request.rb
+- lib/wine_dot_com_api_request/configuration.rb
+- test/wine_dot_com_api_request_test.rb
+- wine_dot_com_api_request.gemspec
+has_rdoc: true
+homepage: https://github.com/cmeiklejohn/wine_dot_com_api_request
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Wine_dot_com_api_request
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: wine_dot_com_api_request
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provides an interface to the wine.com API.
+test_files: 
+- test/wine_dot_com_api_request_test.rb