octopart-ruby 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+0.1.2
+-----
+* [Added CHANGELOG.md](https://github.com/parkerboundy/octopart-ruby/commit/840ec6f89f0d5d07a10f77251a8571f2521a4c0b)
+* [Move APIKeyNotSetError and APIResponseError to exceptions.rb](https://github.com/parkerboundy/octopart-ruby/commit/1860324c6ee4f9ab5348643583f03ac33579de50)
+* [Abstracted requests into make_request(endpoint, query)](https://github.com/parkerboundy/octopart-ruby/commit/fe74cc9c72c75ef757e71e4ad9f422b9a6e1fe1c)
+
+0.1.1
+-----
+* [Cleaned up match method](https://github.com/parkerboundy/octopart-ruby/commit/b64ac2970cdf353e709819c6d4eabe5bd1b7251c)
+* Cleaned up documentation and converted to YARD
+
+0.1.0
+-----
+* [Initial release](https://github.com/parkerboundy/octopart-ruby/commit/08c5a30e3558dfb8895748bbfccf677788da4a66)

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/octopart-ruby.rb

@@ -1,11 +1,5 @@
 require 'httparty'
 
-# APIKeyNotSetError is called when a client is instantiated without an api_key
-class APIKeyNotSetError < StandardError; end
-
-# APIResponseError is called when an API request returns with a code other than 200
-class APIResponseError < StandardError; end
-
 module Octopart
   
   # api_key -  The API key to use
@@ -23,4 +17,5 @@ end
 
 directory = File.expand_path(File.dirname(__FILE__))
 
-require File.join(directory, 'octopart', 'client')
+require File.join(directory, 'octopart', 'client')
+require File.join(directory, 'octopart', 'exceptions')

data/lib/octopart/client.rb

@@ -25,7 +25,6 @@ module Octopart
     def initialize(api_key=nil)
       @api_key = api_key
       @api_key ||= Octopart.api_key
-
     end
 
     # Fetch a category object by its id
@@ -39,8 +38,7 @@ module Octopart
       if id.is_a? Array
         categories(id)
       else
-        response = self.class.get('/categories/get', :query => {:id => id, :apikey => @api_key})
-        validate_response(response)
+        make_request('/categories/get', {:id => id})
       end
     end
     
@@ -53,8 +51,8 @@ module Octopart
     #   # => [Hash]
     def categories(ids)
       raise(ArgumentError, 'ids must be an array') unless ids.is_a?Array
-      response = self.class.get('/categories/get_multi', :query => {:ids => "[#{ids.join(",")}]", :apikey => @api_key})
-      validate_response(response)
+      query = {:ids => "[#{ids.join(",")}]"}
+      make_request('/categories/get_multi', query)
     end
     
     # Execute search over category objects
@@ -68,8 +66,8 @@ module Octopart
     #   # => [Hash]
     def search_categories(query, start=0, limit=10)
       raise(ArgumentError, 'query must be a string > 2 characters and start/limit must be < 100') unless (query.is_a?(String) && query.length > 2 && start.between?(0, 100) &&limit.between?(0,100))    
-      response = self.class.get('/categories/search', :query => {:q => query, :start => start, :limit => limit, :apikey => @api_key})
-      validate_response(response)
+      query = {:q => query, :start => start, :limit => limit}
+      make_request('/categories/search', query)
     end
     
     # Fetch a part object by its id
@@ -83,8 +81,8 @@ module Octopart
       if uid.is_a? Array
         parts(uid)
       else
-        response = self.class.get('/parts/get', :query => {:uid => uid, :apikey => @api_key})
-        validate_response(response)
+        query = {:uid => uid}
+        make_request('/parts/get', query)
       end
     end
     
@@ -97,8 +95,8 @@ module Octopart
     #   # => [Hash]
     def parts(uids)
       raise(ArgumentError, 'uids must be an array') unless uids.is_a?Array
-      response = self.class.get('/parts/get_multi', :query => {:uids => "[#{uids.join(",")}]", :apikey => @api_key})
-      validate_response(response)
+      query = {:uids => "[#{uids.join(",")}]"}
+      make_request('/parts/get_multi', query)
     end
      
     # Execute search over part objects
@@ -118,8 +116,8 @@ module Octopart
     #   # => [Hash]
     def search_parts(query, start=0, limit=10)
       raise(ArgumentError, 'query must be a string > 2 characters, start < 1000, and limit must be < 100') unless (query.is_a?(String) && query.length > 2 && start.between?(0, 1000) &&limit.between?(0,100))
-      response = self.class.get('/parts/search', :query => {:q => query, :start => start, :limit => limit, :apikey => @api_key})
-      validate_response(response)
+      query = {:q => query, :start => start, :limit => limit}
+      make_request('/parts/search', query)
     end
      
     # Suggest a part search query string
@@ -135,7 +133,8 @@ module Octopart
     #   # => [Hash]
     def suggest_parts(query, limit=5)
       raise(ArgumentError, 'query must be a string > 2 characters, and limit must be < 10') unless (query.is_a?(String) && query.length > 2 && limit.between?(0,10))
-      response = self.class.get('/parts/suggest', :query => {:q => query.split(' ').join('+'), :limit => limit, :apikey => @api_key})
+      query = {:q => query.split(' ').join('+'), :limit => limit}
+      make_request('/parts/suggest', query)
     end
      
     # Match (manufacturer,mpn) to part uids
@@ -147,8 +146,8 @@ module Octopart
     #   match_part('Texas Instruments', 'SN74LS240N')
     #   # => [Hash]
     def match_part(manufacturer_name, mpn)
-      response = self.class.get('/parts/match', :query => {:manufacturer_name => manufacturer_name, :mpn => mpn, :apikey => @api_key})
-      validate_response(response)
+      query = {:manufacturer_name => manufacturer_name, :mpn => mpn}
+      make_request('/parts/match', query)
     end
     
     # Fetch a partattribute object by its id
@@ -162,8 +161,8 @@ module Octopart
       if fieldname.is_a? Array
           part_attributes(fieldname)
       else
-        response = self.class.get('/partattributes/get', :query => {:fieldname => fieldname, :apikey => @api_key})
-        validate_response(response)
+        query = {:fieldname => fieldname}
+        make_request('/partattributes/get', query)
       end
     end
     
@@ -176,8 +175,8 @@ module Octopart
     #   # => partattribute hash
     def part_attributes(fieldnames)
       raise(ArgumentError, 'fieldnames must be an array') unless fieldnames.is_a?Array
-      response = self.class.get('/partattributes/get_multi', :query => {:fieldnames => "["+fieldnames.map{|v| "\"#{v}\""}.join(',')+"]", :apikey => @api_key})
-      validate_response(response)
+      query = {:fieldnames => "["+fieldnames.map{|v| "\"#{v}\""}.join(',')+"]"}
+      make_request('/partattributes/get_multi', query)
     end
      
     # Match lines of a BOM to parts
@@ -198,8 +197,8 @@ module Octopart
     #   # => [Hash]
     def bom_match(lines)
       raise(ArgumentError, 'lines must be a hash') unless lines.is_a?(::Hash)
-      response = self.class.get('/bom/match', :query => {:lines => "[{"+lines.map{|k,v| "\"#{k}\":\"#{v}\""}.join(',')+"}]", :apikey => @api_key})
-      validate_response(response)
+      query = {:lines => "[{"+lines.map{|k,v| "\"#{k}\":\"#{v}\""}.join(',')+"}]"}
+      make_request('/bom/match', query)
     end
     
     # Helper method for searches
@@ -232,10 +231,20 @@ module Octopart
     alias_method :match, :match_part
     
     protected
+    def make_request(endpoint, query)
+      query = default_options.merge(query)
+      response = self.class.get(endpoint.to_s, :query => query)
+      validate_response(response)
+    end
+    
     def validate_response(response)
       response.code == 200 ? response.parsed_response : raise(APIResponseError, response.code)
     end
     
+    def default_options
+      {:apikey => @api_key}
+    end
+    
   end
 
 end

data/lib/octopart/exceptions.rb

@@ -0,0 +1,9 @@
+module Octopart
+  
+  # APIKeyNotSetError is called when a client is instantiated without an api_key
+  class APIKeyNotSetError < StandardError; end
+    
+  # APIResponseError is called when an API request returns with a code other than 200
+  class APIResponseError < StandardError; end
+    
+end

data/octopart-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "octopart-ruby"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Parker Boundy"]
-  s.date = "2012-12-20"
+  s.date = "2012-12-24"
   s.description = "Ruby wrapper for the Octopart API"
   s.email = "parkerboundy@gmail.com"
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -27,6 +28,7 @@ Gem::Specification.new do |s|
     "examples/example.rb",
     "lib/octopart-ruby.rb",
     "lib/octopart/client.rb",
+    "lib/octopart/exceptions.rb",
     "octopart-ruby.gemspec",
     "test/fixtures/attribute.json",
     "test/fixtures/attribute_multi.json",

data/test/test_octopart_ruby.rb

@@ -7,7 +7,7 @@ class TestOctopartRuby < Test::Unit::TestCase
     should "require an api key" do
       Octopart.api_key = nil
       
-      assert_raise APIKeyNotSetError do
+      assert_raise Octopart::APIKeyNotSetError do
         Octopart::Client.new()
       end
     end
@@ -96,7 +96,7 @@ class TestOctopartRuby < Test::Unit::TestCase
     should "respond to error codes properly" do
       FakeWeb.register_uri(:get, "http://octopart.com/api/v2/categories/get?id=4174&apikey=123456789", :body => fixture_file("category.json"), :status => ["404", "Not Found"])
       
-      assert_raise APIResponseError do
+      assert_raise Octopart::APIResponseError do
         @client.category(4174)
       end
     end
@@ -173,7 +173,7 @@ class TestOctopartRuby < Test::Unit::TestCase
     should "respond to error codes properly" do
       FakeWeb.register_uri(:get, "http://octopart.com/api/v2/parts/get?uid=39619421&apikey=123456789", :body => fixture_file("part.json"), :status => ["404", "Not Found"])
       
-      assert_raise APIResponseError do
+      assert_raise Octopart::APIResponseError do
         @client.part(39619421)
       end
     end  
@@ -216,7 +216,7 @@ class TestOctopartRuby < Test::Unit::TestCase
     should "respond to error codes properly" do
       FakeWeb.register_uri(:get, "http://octopart.com/api/v2/partattributes/get?fieldname=capacitance&apikey=123456789", :body => fixture_file("attribute.json"), :status => ["404", "Not Found"])
       
-      assert_raise APIResponseError do
+      assert_raise Octopart::APIResponseError do
         @client.part_attribute('capacitance')
       end
     end
@@ -244,7 +244,7 @@ class TestOctopartRuby < Test::Unit::TestCase
     should "respond to error codes properly" do
       FakeWeb.register_uri(:get, "http://octopart.com/api/v2/bom/match?lines=%5B%7B%22mpn%22%3A%22SN74LS240N%22%2C%22manufacturer%22%3A%22Texas%20Instruments%22%7D%5D&apikey=123456789", :body => fixture_file("bom.json"), :status => ["404", "Not Found"])
       
-      assert_raise APIResponseError do
+      assert_raise Octopart::APIResponseError do
         @client.bom_match({"mpn" => "SN74LS240N", "manufacturer" => "Texas Instruments"})
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopart-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000Z
+date: 2012-12-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70163619218620 !ruby/object:Gem::Requirement
+  requirement: &70142811581320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70163619218620
+  version_requirements: *70142811581320
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70163619217920 !ruby/object:Gem::Requirement
+  requirement: &70142811580820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70163619217920
+  version_requirements: *70142811580820
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70163619217100 !ruby/object:Gem::Requirement
+  requirement: &70142811580320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.8.3
   type: :development
   prerelease: false
-  version_requirements: *70163619217100
+  version_requirements: *70142811580320
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70163619216340 !ruby/object:Gem::Requirement
+  requirement: &70142811578640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70163619216340
+  version_requirements: *70142811578640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70163619215560 !ruby/object:Gem::Requirement
+  requirement: &70142811578100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *70163619215560
+  version_requirements: *70142811578100
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70163619214720 !ruby/object:Gem::Requirement
+  requirement: &70142811569780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *70163619214720
+  version_requirements: *70142811569780
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70163619214080 !ruby/object:Gem::Requirement
+  requirement: &70142811568700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70163619214080
+  version_requirements: *70142811568700
 description: Ruby wrapper for the Octopart API
 email: parkerboundy@gmail.com
 executables: []
@@ -97,6 +97,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -106,6 +107,7 @@ files:
 - examples/example.rb
 - lib/octopart-ruby.rb
 - lib/octopart/client.rb
+- lib/octopart/exceptions.rb
 - octopart-ruby.gemspec
 - test/fixtures/attribute.json
 - test/fixtures/attribute_multi.json
@@ -135,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2149321309424623997
+      hash: -4320709216140336670
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: