octopart-ruby 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem "httparty", "0.9.0"
+gem "fakeweb", "1.3.0"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+    multi_xml (0.5.1)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  fakeweb (= 1.3.0)
+  httparty (= 0.9.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Parker Boundy
+
+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,37 @@
+= Octopart-ruby
+
+Octopart-ruby is a simple Ruby wrapper for the Octopart.com API
+
+== Getting Started
+
+To install Octopart-ruby you can either add it to your Gemfile:
+
+    gem "octopart-ruby"
+
+or you can install it from the command line:
+
+    $ gem install octopart-ruby
+    
+
+To create a new instance of the client you will need to register for an API key at http://octopart.com/api/register. Once you have an API key you can use Octopart-ruby as follows:
+
+    @client = Octopart::Client.new(api_key)
+
+== Contributing to Octopart-ruby
+ 
+* 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
+
+Octopart-ruby is released under the MIT license. 
+
+See LICENSE.txt or http://opensource.org/licenses/MIT for further details.
+
+Copyright (c) 2012 Parker Boundy. 
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "octopart-ruby"
+  gem.homepage = "http://github.com/parkerboundy/octopart-ruby"
+  gem.license = "MIT"
+  gem.summary = "Ruby wrapper for the Octopart API"
+  gem.description = "Ruby wrapper for the Octopart API"
+  gem.email = "parkerboundy@gmail.com"
+  gem.authors = ["Parker Boundy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "octopart-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/example.rb

@@ -0,0 +1,37 @@
+require "rubygems"
+require 'octopart-ruby'
+
+@octopart = Octopart::Client.new('02566ff6')
+
+# Fetch a category object by its id
+puts @octopart.category(4174)
+
+# Fetch multiple category objects by their ids
+puts @octopart.categories([4215,4174,4780])
+
+# Execute search over category objects
+puts @octopart.search_categories('resistor')
+
+# Fetch a part object by its id
+puts @octopart.part(39619421)
+
+# Fetch multiple part objects by their ids
+puts @octopart.parts([39619421,29035751,31119928])
+
+# Execute search over part objects
+puts @octopart.search_parts('resistor')
+
+# Suggest a part search query string
+puts @octopart.suggest_parts('sn74f')
+
+# Match (manufacturer,mpn) to part uids
+puts @octopart.match_part('texas instruments', 'SN74LS240N')
+
+# Fetch a partattribute object by its id
+puts @octopart.part_attribute('capacitance')
+
+# Fetch multiple partattribute objects by their ids
+puts @octopart.part_attributes(["capacitance","resistance"])
+
+# Match lines of a BOM to parts
+puts @octopart.bom_match({"mpn_or_sku"=> "60K6871", "manufacturer"=> "Texas Instruments"})

data/lib/octopart-ruby.rb

@@ -0,0 +1,23 @@
+require 'httparty'
+
+# APIKeyNotSet is called when a client is instantiated without an api_key
+class APIKeyNotSet < StandardError; end
+
+module Octopart
+  
+  # api_key -  The API key to use
+  def self.api_key
+    raise APIKeyNotSet if @api_key.nil?
+    @api_key
+  end
+  
+  # api_key -  The API key to use
+  def self.api_key=(api_key)
+    @api_key = api_key
+  end
+  
+end
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+require File.join(directory, 'octopart', 'client')

data/lib/octopart/client.rb

@@ -0,0 +1,283 @@
+# Public: A simple ruby wrapper for the Octopart.com API
+# All methods are module methods and should be called on the Octopart module.
+#
+# Examples
+#
+#   Octopart::Client.new('apikey')
+#   
+module Octopart
+  
+  # Public: An Octopart.com API Client
+  # 
+  #
+  # Examples
+  #
+  #   Octopart::Client.new('apikey')
+  #
+  class Client
+    
+    include HTTParty
+    base_uri 'http://octopart.com/api/v2'
+    format :json
+    
+    
+    # Public: The API key for the client
+    attr_reader :api_key
+    
+    # Public: Initialize an Octopart client
+    #
+    # api_key -  The API key to use
+    # You can get an Octopart API key at http://octopart.com/api/register
+    def initialize(api_key=nil)
+      @api_key = api_key
+      @api_key ||= Octopart.api_key
+      
+    end
+    
+    
+    # Public: Fetch a category object by its id
+    #
+    # id  - The id of a category object
+    #
+    # Examples
+    #
+    #   category(4174)
+    #   # => category hash
+    #
+    # Returns a category hash
+    def category(id)
+      if id.is_a? Array
+        categories(id)
+      else
+        self.class.get('/categories/get', :query => {:id => id, :apikey => @api_key}).parsed_response
+      end
+    end
+    
+    
+    # Public: Fetch multiple category objects by their ids
+    #
+    # ids  - Array of category object ids
+    #
+    # Examples
+    #
+    #   categories([4215,4174,4780])
+    #   # => category hash
+    #
+    # Returns a category hash
+    def categories(ids)
+      raise(ArgumentError, 'ids must be an array') unless ids.is_a?Array
+      self.class.get('/categories/get_multi', :query => {:ids => "[#{ids.join(",")}]", :apikey => @api_key}).parsed_response
+    end
+    
+    # Public: Execute search over category objects
+    #
+    # q - Query string
+    # start - Ordinal position of first result. First position is 0. Default is 0
+    # limit - Maximum number of results to return. Default is 10
+    #
+    # Examples
+    #
+    #   search_categories('resistor')
+    #   # => category hash
+    #
+    # Returns a category 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))    
+      self.class.get('/categories/search', :query => {:q => query, :start => start, :limit => limit, :apikey => @api_key}).parsed_response
+    end
+    
+    # Public: Fetch a part object by its id
+    #
+    # uid  - the id of a part object 
+    #
+    # Examples
+    #
+    #   part(39619421)
+    #   # => part hash
+    #
+    # Returns a part hash
+    def part(uid)
+      if uid.is_a? Array
+        parts(uid)
+      else
+        self.class.get('/parts/get', :query => {:uid => uid, :apikey => @api_key}).parsed_response
+      end
+    end
+    
+    # Public: Fetch multiple part objects by their ids
+    #
+    # uids - JSON encoded list of part object ids. Max number of ids is 100.
+    #
+    # Examples
+    #
+    #   parts([39619421,29035751,31119928])
+    #   # => parts hash
+    #
+    # Returns a part hash
+    def parts(uids)
+      raise(ArgumentError, 'uids must be an array') unless uids.is_a?Array
+      self.class.get('/parts/get_multi', :query => {:uids => "[#{uids.join(",")}]", :apikey => @api_key}).parsed_response
+    end
+     
+    # Public: Execute search over part objects
+    #
+    # query - Query string 
+    # start - Ordinal position of first result. First position is 0. Default is 0. Maximum is 1000.
+    # limit - Number of results to return. Default is 10. Maximum is 100.
+    #
+    # Examples
+    #
+    #   search_parts('capacitor')
+    #   # => part hash
+    #
+    #   search_parts('capacitor', 50)
+    #   # => part hash
+    #
+    #   search_parts('capacitor', 100, 25)
+    #   # => part hash
+    # 
+    # Returns a part 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))
+      self.class.get('/parts/search', :query => {:q => query, :start => start, :limit => limit, :apikey => @api_key}).parsed_response
+    end
+     
+    # Public: Suggest a part search query string
+    #
+    # q - Query string. Minimum of 2 characters.
+    # limit - Maximum number of results to return. Default is 5. Maximum is 10.
+    #
+    # Examples
+    #
+    #   suggest_parts('sn74f')
+    #   # => parts hash
+    #
+    #   suggest_parts('sn74f', 10)
+    #   # => parts hash
+    #
+    # Returns a part 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))
+      self.class.get('/parts/suggest', :query => {:q => query.split(' ').join('+'), :limit => limit, :apikey => @api_key}).parsed_response
+    end
+     
+    # Public: Match (manufacturer,mpn) to part uids
+    #
+    # manufacturer_name - Manufacturer name
+    # mpn - Manufacturer part number
+    #
+    # Examples
+    #
+    #   match_part('Texas Instruments', 'SN74LS240N')
+    #   # => parts hash
+    #
+    # Returns a part hash
+    def match_part(manufacturer_name, mpn)
+      self.class.get('/parts/match', :query => {:manufacturer_name => manufacturer_name, :mpn => mpn, :apikey => @api_key}).parsed_response
+    end
+    
+    # Public: Helper method for  match_part(manufacturer,mpn)
+    #
+    # manufacturer_name - Manufacturer name
+    # mpn - Manufacturer part number
+    #
+    # Examples
+    #
+    #   match_part('Texas Instruments', 'SN74LS240N')
+    #   # => parts hash
+    #
+    # Returns a part hash
+    def match(manufacturer_name, mpn)
+      match_part(manufacturer_name, mpn)
+    end
+    
+    # Public: Fetch a partattribute object by its id
+    #
+    # fieldname - The fieldname of a partattribute object
+    #
+    # Examples
+    #
+    #   part_attribute('capacitance')
+    #   # => partattribute hash
+    #
+    # Returns a partattribute hash
+    def part_attribute(fieldname)
+      if fieldname.is_a? Array
+          part_attributes(fieldname)
+      else
+        self.class.get('/partattributes/get', :query => {:fieldname => fieldname, :apikey => @api_key}).parsed_response
+      end
+    end
+    
+    # Public: Fetch multiple partattribute objects by their ids
+    #
+    # fieldnames - The fieldnames of a partattribute objects
+    #
+    # Examples
+    #
+    #   part_attributes(['capacitance', 'resistance'])
+    #   # => partattribute hash
+    #
+    # Returns a partattribute hash
+    def part_attributes(fieldnames)
+      raise(ArgumentError, 'fieldnames must be an array') unless fieldnames.is_a?Array
+      self.class.get('/partattributes/get_multi', :query => {:fieldnames => "["+fieldnames.map{|v| "\"#{v}\""}.join(',')+"]", :apikey => @api_key}).parsed_response
+    end
+     
+    # Public: Match lines of a BOM to parts
+    #
+    # lines - hash made up of the following optional parameters:
+    #          q - Free form query 
+    #          mpn - MPN string 
+    #          manufacturer - Manufacturer name 
+    #          sku - Supplier SKU string 
+    #          supplier - Supplier name 
+    #          mpn_or_sku - Match on MPN or SKU 
+    #          start=0 - Ordinal position of first item 
+    #          limit=3 - Maximum number of items to return 
+    #          reference - Arbitrary reference string to differentiate results
+    #
+    # Examples
+    #
+    #   bom_match({"mpn_or_sku"=> "60K6871", "manufacturer" => "Texas Instruments"})
+    #   # => match hash
+    #
+    # Returns a match hash
+    def bom_match(lines)
+      raise(ArgumentError, 'lines must be a hash') unless lines.is_a?(::Hash)
+      self.class.get('/bom/match', :query => {:lines => "[{"+lines.map{|k,v| "\"#{k}\":\"#{v}\""}.join(',')+"}]", :apikey => @api_key}).parsed_response
+    end
+    
+    # Public: Helper method for searches
+    #
+    # type - String name of the type
+    # query - Query string 
+    # start - Ordinal position of first result. First position is 0. Default is 0. Maximum is 1000.
+    # limit - Number of results to return. Default is 10. Maximum is 100.
+    #
+    # Examples
+    #
+    #   search_parts('parts', 'capacitor')
+    #   # => part hash
+    #
+    #   search_parts('categories', 'capacitor', 50)
+    #   # => part hash
+    #
+    #   search_parts('parts', 'capacitor', 100, 25)
+    #   # => part hash
+    # 
+    # Returns a part hash
+    def search(type, 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))
+      if type.downcase == 'part' || type.downcase == 'parts'
+        search_parts(query, start, limit)
+      elsif type.downcase == 'category' || type.downcase == 'categories'
+        search_categories(query, start, limit)
+      else
+        raise(ArgumentError, "type must be either 'parts' or 'categories'")
+      end
+    end
+    
+  end
+
+end