Project

traceparts

0.0
No commit activity in last 3 years
No release in over 3 years
tracepartscgtrader/tracepartsHomepageDocumentationSource CodeBug TrackerWiki
A Ruby interface to the Traceparts API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
13,756
Stars
0
Forks
1
Watchers
15
 Releases
Current version
0.1.4
Total releases
5
First release
2016-02-03
Latest release
2016-09-22
 Issues
Open Issues
0
Closed Issues
1
Total Issues
1
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
2
Pull Request Acceptance Rate
66%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-05-10
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.11
pry
>= 0
rake
~> 10.0
rspec
~> 3.0

Runtime

faraday
>= 0
json
>= 0
 Project Readme

Traceparts

Minimal Traceparts traceparts.com API wrapper.

Currently it lacks tests and http error codes handling.

It can be used for:

Installation

Add this line to your application's Gemfile:

gem 'traceparts'

And then execute:

$ bundle

Or install it yourself as:

$ gem install traceparts

Usage

Setup client

ACCESS_TOKEN = 'YOUR_TRACEPARTS_ACCESS_TOKEN'

client = Traceparts::Client.new(ACCESS_TOKEN)

Some test data

id = 'PNEUMADYNE'
part_number = 'A11-31-14'
email = 'your@email.com'
format_id = 11

Catalog related functionality

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

user = client.user(user_email)

# Option 1 (suggested)
user.exists? # true or false
user.register(company, country, first_name, last_name, phone) # true or false

user.email

# Option 2
client.user_exists?(user_email) # true or false
client.register_user(user_email, company, country, first_name, last_name, phone) # true or false

PartNumber data related functionality

Option 1 (suggested)

part = client.part(id, part_number, email)

details = part.details
formats = part.available_formats
download_link = part.download_archive_link(format_id)

Option 2

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.

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.