traceparts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a43230d74a3765be73beaf25f26e37e72536533
+  data.tar.gz: 5dfd7c5db00897d4a3a5f095571e559cc53773bf
+SHA512:
+  metadata.gz: 645c42bef8effa5eb3d8e257e86dcc914b83f97d75923686e8ce4731e7c5db74f1ae569a7fbcf5a99748157980ce9678245020a3d9fa594ed6879ebc31ca3515
+  data.tar.gz: 5e4ecb607679ed34976a8aa4cb39b4e31cc90f8d8b398217a5ce86f11f8388ccd4eb426bd0c0b9bcd974696a367922023376b0006b1b24edf4dd3026256b8bc0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/crawler/
+traceparts-0.1.0.gem
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in traceparts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zilvinas
+
+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.md

@@ -0,0 +1,119 @@
+# Traceparts
+
+Minimal Traceparts [traceparts.com](http://www.traceparts.com/developers) API wrapper.
+
+Currently it lacks tests and [http error codes](http://www.traceparts.com/developers/http-error-codes/) handling.
+
+It can be used for:
+
+  * [List of catalogs](http://www.traceparts.com/developers/list-catalogs-api/) endpoint
+  * [List of categories](http://www.traceparts.com/developers/categories-list-api/) endpoint
+  * [List of products](http://www.traceparts.com/developers/products-list-api/) endpoint - Default size is 30000 (could be improved)
+  * [PartNumber data](http://www.traceparts.com/developers/partnumber-data-api/) endpoint
+  * [Availability of CAD data](http://www.traceparts.com/developers/cad-format-availability-api/) endpoint
+  * [Download CAD file](http://www.traceparts.com/developers/download-cad-file-api/) endpoint - extract archive link
+  * [User existence](http://www.traceparts.com/developers/user-account-api/) endpoint
+  * [User creation](http://www.traceparts.com/developers/user-account-creation-api/) endpoint
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'traceparts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traceparts
+
+## Usage
+
+### Setup client
+
+```ruby
+ACCESS_TOKEN = 'YOUR_TRACEPARTS_ACCESS_TOKEN'
+
+client = Traceparts::Client.new(ACCESS_TOKEN)
+```
+
+### Some test data
+
+```ruby
+id = 'PNEUMADYNE'
+part_number = 'A11-31-14'
+email = 'your@email.com'
+format_id = 11
+```
+
+### Catalog related functionality
+
+```ruby
+catalogs = client.catalogs
+catalog = catalogs.first
+
+categories = catalog.categories
+category = categories.first
+
+category_products = category.products
+category_product = category_products.first
+
+catalog_products = catalog.products
+catalog_product = catalog_products.first
+```
+
+### User related functionality
+
+```ruby
+user = client.user(user_email)
+
+# Option 1 (suggested)
+user.exists? # true or false
+user.register(company, country) # true or false
+
+user.email
+
+# Option 2
+client.user_exists?(user_email) # true or false
+client.register_user(user_email, company, country) # true or false
+```
+
+### PartNumber data related functionality
+
+#### Option 1 (suggested)
+
+```ruby
+part = client.part(id, part_number, email)
+
+details = part.details
+formats = part.available_formats
+download_link = part.download_archive_link(format_id)
+```
+
+#### Option 2
+
+```ruby
+details = client.part_details(id, part_number, email)
+formats = client.available_formats(id, part_number, email)
+download_link = client.download_archive_link(id, part_number, format_id, email)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Or if you want to be fancy and use `pry` instead of `irb` you can also run `rake console` that I have specifically made for easier testing.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CGTrader/traceparts.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "pry -r traceparts -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "traceparts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/traceparts.rb

@@ -0,0 +1,3 @@
+require "traceparts/version"
+
+require 'traceparts/client'

data/lib/traceparts/cad_format.rb

@@ -0,0 +1,12 @@
+module Traceparts
+  class CadFormat
+    attr_reader :id, :name
+
+    def initialize(client, data)
+      @client = client
+
+      @id = data.fetch('cadFormatId')
+      @name = data.fetch('cadFormatName')
+    end
+  end
+end

data/lib/traceparts/catalog.rb

@@ -0,0 +1,24 @@
+module Traceparts
+  class Catalog
+    attr_reader :id, :title, :picture_url, :published, :updated, :type
+
+    def initialize(client, data)
+      @client = client
+
+      @id = data.fetch('classificationId')
+      @title = data.fetch('title')
+      @picture_url = data.fetch('pictureUrl')
+      @published = data.fetch('published')
+      @updated = data.fetch('updated')
+      @type = data.fetch('classType')
+    end
+
+    def products
+      @client.products(id)
+    end
+
+    def categories
+      @client.categories(id)
+    end
+  end
+end

data/lib/traceparts/category.rb

@@ -0,0 +1,21 @@
+module Traceparts
+  class Category
+    attr_reader :path, :title, :path_caption, :classification_id, :picture_url, :level, :description
+
+    def initialize(client, data)
+      @client = client
+
+      @path = data.fetch('path')
+      @title = data.fetch('title')
+      @path_caption = data.fetch('pathCaption')
+      @classification_id = data.fetch('classificationId')
+      @picture_url = data.fetch('pictureUrl')
+      @level = data.fetch('level')
+      @description = data.fetch('description')
+    end
+
+    def products
+      @client.products(classification_id, path)
+    end
+  end
+end

data/lib/traceparts/client.rb

@@ -0,0 +1,184 @@
+require 'faraday'
+require 'json'
+require 'traceparts/catalog'
+require 'traceparts/product'
+require 'traceparts/category'
+require 'traceparts/part'
+require 'traceparts/part_details'
+require 'traceparts/cad_format'
+require 'traceparts/user'
+
+module Traceparts
+  class Client
+    API_BASE = 'http://ws.tracepartsonline.net'
+    WEB_SERVICE_PATH = '/tpowebservices'
+
+    def initialize(api_key)
+      @api_key = api_key
+
+      @connection = Faraday.new(url: API_BASE) do |faraday|
+        faraday.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def catalogs
+      json_catalogs['classificationList'].map { |catalog| Catalog.new(self, catalog) }
+    end
+
+    def categories(classification_id)
+      json_categories(classification_id)['categorieList'].map { |category| Category.new(self, category) }
+    end
+
+    # Returns product family id's for specified page
+    def page_products(classification_id, category_path = nil, page = 1)
+      json = json_products(classification_id, category_path, page)
+
+      products_present?(json) ? bind_products(json) : []
+    end
+
+    # Returns all product family id's available
+    def products(catalog_id, category_path = nil)
+      page = 1
+      all_products = []
+
+      while (products_for_page = page_products(catalog_id, category_path, page)).any? do
+        all_products.push(*products_for_page)
+
+        page += 1
+      end
+
+      all_products
+    end
+
+    def part_details(classification_id, part_number, user_email)
+      json = json_part_details(classification_id, part_number, user_email)
+
+      PartDetails.new(json)
+    end
+
+    def available_formats(classification_id, part_number, user_email)
+      json = json_available_formats(classification_id, part_number, user_email)
+
+      json.map { |format| CadFormat.new(self, format) }
+    end
+
+    def download_archive_link(classification_id, part_number, cad_format_id, user_email)
+      response = get_request('DownloadCADPath', {
+        'PartNumber' => part_number,
+        'ClassificationID' => classification_id,
+        'CADFormatID' => cad_format_id,
+        'UserEmail' => user_email
+      })
+
+      json = JSON.parse(response.body)
+
+      json[1][1][1]
+    end
+
+    def part(classification_id, part_number, user_email)
+      Part.new(self, classification_id, part_number, user_email)
+    end
+
+    def user(user_email)
+      User.new(self, user_email)
+    end
+
+    def user_exists?(user_email)
+      response = get_request('CheckLogin', {
+        'UserEmail' => user_email
+      })
+
+      json = JSON.parse(response.body)
+
+      json['registered'] == true
+    end
+
+    def register_user(user_email, company, country)
+      response = get_request('UserRegistration', {
+        'UserEmail' => user_email,
+        'company' => company,
+        'country' => country
+      })
+
+      json = JSON.parse(response.body)
+
+      json['registered'] == true
+    end
+
+    private
+
+    def json_catalogs
+      response = get_request('CatalogsList')
+
+      JSON.parse(response.body)
+    end
+
+    def json_categories(classification_id)
+      response = get_request('CategoriesList', {
+        'ClassificationId' => classification_id
+      })
+
+      JSON.parse(response.body)
+    end
+
+    def json_products(catalog_id, category_path, page)
+      response = get_request('ProductsList', {
+        'ClassificationID' => catalog_id,
+        'Path' => category_path,
+        'Page' => page
+      })
+      json = response.body
+
+      return {} unless json && json.length >= 2
+
+      JSON.parse(json)
+    end
+
+    def json_part_details(classification_id, part_number, user_email)
+      response = get_request('PartNumberData', {
+        'PartNumber' => part_number,
+        'ClassificationID' => classification_id,
+        'UserEmail' => user_email
+      })
+
+      JSON.parse(response.body)
+    end
+
+    def json_available_formats(classification_id, part_number, user_email)
+      response = get_request('CADFormatsList', {
+        'PartNumber' => part_number,
+        'ClassificationID' => classification_id,
+        'UserEmail' => user_email
+      })
+
+      JSON.parse(response.body)
+    end
+
+    def bind_products(json)
+      json['productList'].map { |product| Product.new(self, product) }
+    end
+
+    def products_present?(json)
+      !json['productList'].nil?
+    end
+
+    def get_request(endpoint, params = {})
+      @connection.get("#{WEB_SERVICE_PATH}/#{endpoint}", default_params.merge(params))
+    end
+
+    def post_request(endpoint, params = {})
+      @connection.post(endpoint, default_params.merge(params))
+    end
+
+    def default_params
+      {
+        'ApiKey' => @api_key,
+        'Format' => 'json',
+        options: {
+          timeout: 50,
+          open_timeout: 50
+        }
+      }
+    end
+  end
+end

data/lib/traceparts/part.rb

@@ -0,0 +1,25 @@
+module Traceparts
+  class Part
+    attr_reader :classification_id, :part_number, :user_email
+
+    def initialize(client, classification_id, part_number, user_email)
+      @client = client
+
+      @classification_id = classification_id
+      @part_number = part_number
+      @user_email = user_email
+    end
+
+    def details
+      @client.part_details(classification_id, part_number, user_email)
+    end
+
+    def available_formats
+      @client.available_formats(classification_id, part_number, user_email)
+    end
+
+    def download_archive_link(cad_format_id)
+      @client.download_archive_link(classification_id, part_number, cad_format_id, user_email)
+    end
+  end
+end

data/lib/traceparts/part_details.rb

@@ -0,0 +1,26 @@
+module Traceparts
+  class PartDetails
+    attr_reader :title, :description, :long_description, :big_picture, :manufacturer_id, :manufacturer_name,
+                :manufacturer_picture, :manufacturer_description, :manufacturer_emails, :manufacturer_websites,
+                :manufacturer_address
+
+    def initialize(data)
+      global_info = data.fetch('globalInfo')
+      part_info = global_info.fetch('partInfo')
+      manufacturer_info = global_info.fetch('manufacturerInfo')
+
+      @title = part_info.fetch('titlePart')
+      @description = part_info.fetch('description')
+      @long_description = part_info.fetch('longDescription')
+      @big_picture = part_info.fetch('partPictureUrl')
+      @manufacturer_id = part_info.fetch('manufacturerID')
+      @manufacturer_name = part_info.fetch('manufacturerName')
+      @manufacturer_picture= part_info.fetch('manufacturerPictureUrl')
+
+      @manufacturer_description = manufacturer_info.fetch('description')
+      @manufacturer_emails = manufacturer_info.fetch('emails')
+      @manufacturer_websites = manufacturer_info.fetch('webSites')
+      @manufacturer_address = manufacturer_info.fetch('address')
+    end
+  end
+end

data/lib/traceparts/product.rb

@@ -0,0 +1,19 @@
+module Traceparts
+  class Product
+    attr_reader :id, :title, :manufacturer_id, :manufacturer_name, :picture_url, :published, :updated,
+                :manufacturer_picture_url
+
+    def initialize(client, data)
+      @client = client
+
+      @id = data.fetch('partID')
+      @title = data.fetch('title')
+      @manufacturer_id = data.fetch('manufacturerID')
+      @manufacturer_name = data.fetch('manufacturerName')
+      @picture_url = data.fetch('partPictureUrl')
+      @published = data.fetch('published')
+      @updated = data.fetch('updated')
+      @manufacturer_picture_url = data.fetch('manufacturerPictureUrl')
+    end
+  end
+end

data/lib/traceparts/user.rb

@@ -0,0 +1,21 @@
+module Traceparts
+  class User
+    attr_reader :email, :company, :country
+
+    def initialize(client, email)
+      @client = client
+
+      @email = email
+      @company = nil
+      @coutry = nil
+    end
+
+    def exists?
+      @client.user_exists?(email)
+    end
+
+    def register(company, country)
+      @client.register_user(email, company, country)
+    end
+  end
+end

data/lib/traceparts/version.rb

@@ -0,0 +1,3 @@
+module Traceparts
+  VERSION = "0.1.0"
+end

data/traceparts.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'traceparts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "traceparts"
+  spec.version       = Traceparts::VERSION
+  spec.authors       = ["Zilvinas"]
+  spec.email         = ["zil.kucinskas@gmail.com"]
+
+  spec.summary       = %q{A Ruby interface to the Traceparts API}
+  spec.homepage      = "https://github.com/CGTrader/traceparts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: traceparts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zilvinas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- zil.kucinskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/traceparts.rb
+- lib/traceparts/cad_format.rb
+- lib/traceparts/catalog.rb
+- lib/traceparts/category.rb
+- lib/traceparts/client.rb
+- lib/traceparts/part.rb
+- lib/traceparts/part_details.rb
+- lib/traceparts/product.rb
+- lib/traceparts/user.rb
+- lib/traceparts/version.rb
+- traceparts.gemspec
+homepage: https://github.com/CGTrader/traceparts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the Traceparts API
+test_files: []