whiplash_api 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Whiplash Merchandising/Mark Dickson
+
+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/README.rdoc

@@ -0,0 +1,70 @@
+Whiplash API V1 - Ruby Client
+================================
+
+This library provides a wrapper around the Whiplash Merchandising REST API for use within Ruby apps or via the console.
+
+== Note
+
+**If you are using a Rails app, the advised approach is to use ActiveResource. You can get started or gain inspiration from our example Rails app: https://github.com/ideaoforder/whiplash-rails-example**
+
+== Requirements
+
+- Ruby 1.8.7+
+- Rubygems
+- JSON
+- ActiveResource
+
+A valid API key is required to authenticate requests. You can find your API key on your customer account page.
+
+== Installation
+
+```
+gem install whiplash_api 
+```
+
+Or if you're using Bundler:
+
+```
+gem 'whiplash_api'
+```
+
+== Configuration
+
+To use the API client in your Ruby code, provide the required credentials as follows:
+
+```
+require 'rubygems'
+require 'whiplash_api'
+
+WhiplashApi::Base.api_key = 'XXXXXXXXXXXXX'
+```
+
+== Usage
+
+The API currently gives you access to your Orders, Items, and OrderItems.
+
+```
+$ irb
+>
+> WhiplashApi::Base.api_key = 'XXXXXXXXXXXXX'
+>
+> items = WhiplashAPI::Item.all
+>
+> order = WhiplashAPI::Order.last
+>
+```
+
+== Contributing to the Whiplash API Gem
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Whiplash Merchandising/Mark Dickson. See LICENSE.txt for further details.
+

data/lib/whiplash_api.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require 'active_resource'
+
+require 'whiplash_api/base'
+require 'whiplash_api/item'
+require 'whiplash_api/order'
+require 'whiplash_api/order_item'

data/lib/whiplash_api/base.rb

@@ -0,0 +1,46 @@
+module WhiplashAPI
+
+  # Example Class Method
+  # def reserved(*names)
+  #   class_variable_set(:@@reserved, names.collect{|x| x.to_s})
+  # end
+
+  class Base < ActiveResource::Base
+    extend WhiplashAPI
+    
+    self.site = 'http://localhost:3000/api/'
+    self.format = :json
+    
+    # Thanks to Brandon Keepers for this little nugget:
+    # http://opensoul.org/blog/archives/2010/02/16/active-resource-in-practice/
+    class << self
+      # If headers are not defined in a given subclass, then obtain
+      # headers from the superclass.
+      def headers
+        if defined?(@headers)
+          @headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          @headers ||= {}
+        end
+      end
+      
+      def api_key=(api_key)
+        headers['X-API-KEY'] = api_key
+      end
+      
+      def api_version=(v)
+        headers['X-API-VERSION'] = v
+      end
+    
+    end
+    
+    # Example Instance Method
+    # def class_name
+    #   self.class.name.split('::').last.downcase
+    # end
+        
+  end
+
+end

data/lib/whiplash_api/item.rb

@@ -0,0 +1,7 @@
+module WhiplashAPI
+  
+  class Item < Base
+
+  end
+
+end

data/lib/whiplash_api/order.rb

@@ -0,0 +1,7 @@
+module WhiplashAPI
+  
+  class Order < Base
+
+  end
+
+end

data/lib/whiplash_api/order_item.rb

@@ -0,0 +1,7 @@
+module WhiplashAPI
+  
+  class OrderItem < Base
+    
+  end
+
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: whiplash_api
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  segments_generated: true
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Dickson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activesupport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        segments_generated: true
+        version: 2.3.5
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activeresource
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        segments_generated: true
+        version: 2.3.5
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rdoc
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        segments_generated: true
+        version: "3.12"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        segments_generated: true
+        version: 1.0.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        segments_generated: true
+        version: 1.8.4
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id006
+description: Ruby Gem for connecting to the Whiplash Merchandising API
+email: mark@sitesteaders.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/whiplash_api.rb
+- lib/whiplash_api/base.rb
+- lib/whiplash_api/item.rb
+- lib/whiplash_api/order.rb
+- lib/whiplash_api/order_item.rb
+- LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ideaoforder/whiplash_api
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      segments_generated: true
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      segments_generated: true
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for connecting to the Whiplash Merchandising API
+test_files: []
+