oshpark 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ee78c703d525696803787f9a3b4f84d6249404d
+  data.tar.gz: c329b89fc0acdbdcd5b2fffc5712e69868db28b1
+SHA512:
+  metadata.gz: bd155da443cc8ff5467e0aa0fc4d1201738149203c990942ecbef3382b1433250aed80fb446ca5080fac53c670657b4b1872a8abc05430e8f91b716db4b8c878
+  data.tar.gz: fe3cd0d02b224992ffbd1c1454a654b52a2952a240f88fed5756d95fb63872f98111e06918d617dd6ec9a058f5c7a68168bccb2a680c211193813574394ea7e5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.1.2'
+
+# Specify your gem's dependencies in oshpark.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    oshpark (0.0.3)
+      micro_token
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    cucumber (1.3.15)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-bundler (2.0.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+    guard-cucumber (1.4.1)
+      cucumber (>= 1.2.0)
+      guard (>= 1.1.0)
+    guard-rspec (4.2.9)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    listen (2.7.7)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.6)
+    method_source (0.8.2)
+    micro_token (0.0.3)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.3.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    slop (3.5.0)
+    thor (0.19.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  byebug
+  cucumber
+  guard-bundler
+  guard-cucumber
+  guard-rspec
+  oshpark!
+  pry
+  rake
+  rspec-core
+  rspec-its
+  rspec-mocks

data/Guardfile

@@ -0,0 +1,17 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Harton
+
+MIT License
+
+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,85 @@
+# Oshpark
+##An electric ecosystem
+
+[ ![Codeship Status for OSHPark/ruby-api-client](https://codeship.io/projects/a0abc8d0-d247-0131-3eb6-7653b9bc7be9/status?branch=master)](https://codeship.io/projects/23318)
+
+[OSH Park](https://oshpark.com) is a community printed circuit board (PCB) order.
+The Oshpark gem allows developers to easily access the Oshpark API. Developer resources can be found at [https://oshpark.com/developer](https://oshpark.com/developer)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oshpark'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oshpark
+
+## Usage
+
+Before you begin you need to have an [Oshpark account](http://oshpark.com/users/sign_up) and then request access to the Oshpark API. Do this by contacting ????
+
+This gem provides two interfaces to the OShpark API.
+
+### Low level API
+
+For use when you have an ORM, framework or pre-exsiting classes that you want to load the Oshpark data into.
+
+The API consists of a number of methods that map to the methods exposed by the Oshpark REST API. These methods take Ruby hashes representing the request data and return hashes of the API responses. Refer to [https://oshpark.com/developer/resources](https://oshpark.com/developer/resources) for details.
+
+First create an Oshpark::client object and authenticate;
+
+    client = Oshpark::client
+    client.authenticate 'jane@resistor.io', {with_password: 'secret'}
+
+Then you can can use this object to interact with Oshpark;
+
+    file = File.open('my_pcb.zip', 'r')
+    upload = client.create_upload file
+    ...
+    my_projects = client.projects
+    ...
+    project = client.project 'id'
+    client.update_project project["id"], {"name" => "my awesome project"}
+    ...
+    new_order = client.create_order
+    ...
+
+All low level methods will call to Oshpark's servers. Refer to the [source documentation](http://www.rubydoc.info/github/OSHPark/ruby-api-client/master) for more detailed information on each of the available methods.
+
+### High Level API
+
+This is more suited to when you are writing a script or application and you want to use Ruby objects to represent the Oshpark data. It uses the Low Level API underneath but wraps the return data in nice Ruby objects.
+
+Again begin by creating an Oshpark::client and authenticating;
+
+    client = Oshpark::client
+    client.authenticate 'jane@resistor.io', {with_password: 'secret'}
+
+    file = File.open('my_pcb.zip', 'r')
+    upload = Oshpark::Upload.create file
+    ...
+    my_projects = Oshpark::Project.all
+    ...
+    project = Oshpark::Project.find 'id'
+    project.name = "my awesome project"
+    project.save!
+    ...
+    new_order = Oshpark::Order.create
+    ...
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/oshpark/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec
+

data/bin/oshpark

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'byebug'
+
+require 'oshpark'
+
+# Oshpark::client
+
+@client = Oshpark::client url: 'http://localhost:3000/api/v1',  connection: Oshpark::Connection
+
+@client.authenticate 'jamesotron', 'frobotz'
+puts "authed!" if @client.authenticated?
+
+projects = Oshpark::Project.all
+
+puts "Retrieved #{projects.size} projects:"
+projects.each do |project|
+  puts "  - #{project.name}"
+end
+
+project = Oshpark::Project.find projects.last.id
+puts "Retrieved single project by id: #{project.name}"
+
+# project.name = "my awesome project"
+# project.save!
+
+orders = Oshpark::Order.all # @client.orders
+
+puts "Retrieved #{orders.size} orders:"
+orders.each do |order|
+  puts "  - #{order.quantity} x #{order.project_name}"
+end
+
+order = Oshpark::Order.find orders.first.id # @client.order orders.first.id
+puts "Retrieved single order by id: #{order.quantity} x #{order.project_name}"
+
+panels = Oshpark::Panel.all
+puts "Retrieved #{panels.size} panels:"
+panels.each do |panel|
+  puts "  - #{panel.scheduled_order_time}"
+end
+
+panel = Oshpark::Panel.find panels.last.id
+puts "Retrieved single panel by id: #{panel.scheduled_order_time}"

data/lib/oshpark.rb

@@ -0,0 +1,31 @@
+require "oshpark/version"
+require "oshpark/ext"
+require "oshpark/client"
+require "oshpark/connection"
+require "oshpark/model"
+require "oshpark/dimensionable"
+require "oshpark/order_option"
+require "oshpark/project"
+require "oshpark/order"
+require "oshpark/panel"
+require "oshpark/image"
+require "oshpark/layer"
+require "oshpark/user"
+require "oshpark/import"
+require "oshpark/upload"
+require "oshpark/token"
+require "oshpark/address"
+require "oshpark/shipping_rate"
+
+module Oshpark
+
+  module_function
+
+  def client *args
+    if args.size > 0
+      @client = Client.new *args
+    else
+      @client ||= Client.new
+    end
+  end
+end

data/lib/oshpark/address.rb

@@ -0,0 +1,46 @@
+module Oshpark
+  class Address
+    REQUIRED_ARGS = %w|name address_line_1 address_line_2 city country|
+    def self.attrs
+      %w| name company_name address_line_1 address_line_2 city state zip_or_postal_code country phone_number is_business |
+    end
+
+    include Model
+
+    attrs.each {|a| attr_accessor a }
+
+    def initialize args={}
+      args = check_args args
+      Address.attrs.each do |a|
+        v = args.fetch(a, nil)
+        public_send :"#{a}=", v
+      end
+    end
+
+    def to_h
+      {}.tap do |hash|
+        Address.attrs.each do |a|
+          hash[a] = public_send a
+        end
+      end
+    end
+
+    private
+
+    def check_args args
+      unless (args.keys.map(&:to_s) & REQUIRED_ARGS) == REQUIRED_ARGS
+        raise ArgumentError, "Missing required arguments #{(REQUIRED_ARGS - args.keys).join(' ')}"
+      end
+
+      stingify_hash_keys args
+    end
+
+    def stingify_hash_keys hash
+      {}.tap do |h|
+        hash.each do |k, v|
+          h[k.to_s] = v
+        end
+      end
+    end
+  end
+end

data/lib/oshpark/client.rb

@@ -0,0 +1,222 @@
+require 'openssl'
+require 'json'
+
+module Oshpark
+  class Client
+    attr_accessor :token, :connection
+
+    # Create an new Client object.
+    #
+    # @param connection:
+    # pass in a subclass of connection which implements the `request` method
+    # with whichever HTTP client library you prefer.  Default is Net::HTTP.
+    def initialize args = {}
+      url = args.fetch(:url, "https://oshpark.com/api/v1")
+      connection = args.fetch(:connection, Connection)
+
+      self.connection = if connection.respond_to? :new
+        connection.new url
+      else
+        connection
+      end
+      refresh_token
+    end
+
+    # Authenticate to the API using a email and password.
+    #
+    # @param email
+    # @param credentials
+    #   A hash with either the `with_password` or `with_api_secret` key.
+    def authenticate email, credentials={}
+      if password = credentials[:with_password]
+        refresh_token email: email, password: password
+      elsif secret = credentials[:with_api_secret]
+        api_key = OpenSSL::Digest::SHA256.new("#{email}:#{secret}:#{token.token}").to_s
+        refresh_token email: email, api_key: api_key
+      else
+        raise ArgumentError, "Must provide either `with_password` or `with_api_secret` arguments."
+      end
+    end
+
+    # Retrieve a list of projects for the current user.
+    def projects
+      get_request 'projects'
+    end
+
+    # Retrieve a particular project from the current user's collection by ID.
+    #
+    # @param id
+    def project id
+      get_request "projects/#{id}"
+    end
+
+    # Approve a particular project from the current user's collection by ID.
+    # We strongly suggest that you allow the user to view the rendered images
+    # in Project#top_image, Project#bottom_image and Project#layers[]#image
+    # You should probably call Project#approve! instead.
+    #
+    # @param id
+    def approve_project id
+      get_request "projects/#{id}/approve"
+    end
+
+    # Update a project's data.
+    #
+    # @param id
+    # @param attrs
+    # A hash of attributes to update.
+    def update_project id, attrs
+      put_request "projects/#{id}", project: attrs
+    end
+
+    # Destroy a particular project from the current user's collection by ID.
+    #
+    # @param id
+    def destroy_project id
+      delete_request "projects/#{id}"
+      true
+    end
+
+    # List all the current user's orders, and their status.
+    def orders
+      get_request 'orders'
+    end
+
+    # Retrieve a specific order by ID.
+    #
+    # @param id
+    def order id
+      get_request "orders/#{id}"
+    end
+
+    # Create a new Order
+    def create_order
+      post_request "orders"
+    end
+
+    # Add a Project to an Order
+    #
+    # @param id
+    # @param project_id
+    # @param quantity
+    def add_order_item id, project_id, quantity
+      put_request "orders/#{id}/add_item", {project_id: project_id, quantity: quantity}
+    end
+
+    # Set the delivery address for an Order
+    #
+    # @param id
+    # @param address
+    def set_order_address id, address
+      put_request "orders/#{id}/set_address", address.to_h
+    end
+
+    # Set the delivery address for an Order
+    #
+    # @param id
+    # @param carrier_name
+    # @param service_name
+    def set_order_shipping_rate id, carrier_name, service_name
+      put_request "orders/#{id}/set_shipping_rate", {carrier_name: carrier_name, service_name: service_name}
+    end
+
+    # Checkout a specific order by ID.
+    #
+    # @param id
+    def checkout_order id
+      put_request "orders/#{id}/checkout"
+    end
+
+    # Cancel a specific order by ID.
+    # This can only be done when the order is in the 'RECEIVED' and
+    # 'AWAITING PANEL' states.
+    #
+    # @param id
+    def cancel_order id
+      delete_request "orders/#{id}"
+      true
+    end
+
+    # List all currently open and recently closed panels, including some
+    # interesting information about them.
+    def panels
+      get_request "panels"
+    end
+
+    # Retrieve a specific panel by ID.
+    #
+    # @param id
+    def panel id
+      get_request "panels/#{id}"
+    end
+
+    # Retrieve a specific upload by ID
+    #
+    # @param id
+    def upload id
+      get_request "uploads/#{id}"
+    end
+
+    # Create an upload by passing in an IO
+    #
+    # @param io
+    # An IO object.
+    def create_upload io
+      post_request "uploads", {file: io}
+    end
+
+    # Retrieve a specific import by ID
+    #
+    # @param id
+    def import id
+      get_request "imports/#{id}"
+    end
+
+    # Create an import by passing in a URL
+    #
+    # @param io
+    # A URL
+    def create_import url
+      post_request "imports", {url: url}
+    end
+
+    # Do we have a currently valid API token?
+    def has_token?
+      !!@token
+    end
+
+    # Are we successfully authenticated to the API?
+    def authenticated?
+      @token && !!@token.user
+    end
+
+    private
+
+    def connection
+      @connection
+    end
+
+    def refresh_token params={}
+      json = post_request 'sessions', params
+      self.token = Token.from_json json['api_session_token']
+      # Hey @hmaddocks - how are we going to set a timer to make the token refresh?
+    end
+
+    def post_request endpoint, params={}
+      connection.request :post, endpoint, params, token
+    end
+
+    def put_request endpoint, params={}
+      connection.request :put, endpoint, params, token
+    end
+
+    def get_request endpoint, params={}
+      connection.request :get, endpoint, params, token
+    end
+
+    def delete_request endpoint, params={}
+      connection.request :delete, endpoint, params, token
+    end
+  end
+
+end