reshape 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97ce0c036d8b1e1ee167623535faab9d3edec236
+  data.tar.gz: 821216ca55ba7fb15f8902a934b572ce88594a8c
+SHA512:
+  metadata.gz: a1fa673a17b7d6f7bf484a9669226c5c22a542b8a328def3169a66fe707d26cce2d5d8e2f795d4d77d32c8780bcfa72525a3463303e2dfd0cb20b6bcf777ead6
+  data.tar.gz: 3ffd941a5c3ba8c568f0d06ccfe6fac9a487ae0ad6a1d3b4870e2ea06090675e212121d6436ddece75a6e7b63740fa97929d1c074319fc446d226e5864afae19

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Barton
+
+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,77 @@
+# Reshape: An API Wrapper for Shapeways
+
+This gem is an API wrapper for the [Shapeways API](http://developer.shapeways.com/)
+
+It supports the Shapeways API which uses OAuth 1.0a.
+
+## Usage
+
+This gem does not contain any methods for authentication. Everyone tends to use something a little bit different, so the goal was to abstract out the OAuth authentication and allow you to bring your own, if you desire. You only need to supply the tokens. However, I also created an OmniAuth strategy to support the Shapeways API. So, if you're already using OmniAuth in your project, you can easily add the strategy with my omniauth-shapewats gem according to the instructions found here: [Shapeways OmniAuth Strategy](/phy5ics/omniauth-shapeways)
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem 'reshape'
+```
+
+Then instantiate the client using the oAuth tokens (this example implies using Foreman and an .env file that contain these values):
+
+```ruby
+Reshape::Client.new({
+  consumer_token: ENV['SHAPEWAYS_CONSUMER_TOKEN'], 
+  consumer_secret: ENV['SHAPEWAYS_CONSUMER_SECRET'], 
+  oauth_token: ENV['SHAPEWAYS_OAUTH_TOKEN'], 
+  oauth_secret: ENV['SHAPEWAYS_OAUTH_SECRET']
+})
+```
+
+The consumer_token and consumer_secret are supplied by Shapeways once you create a developer account and an app. Additional information can be found on the [Shapeways Developer Site](http://developer.shapeways.com/).
+
+The oauth_token and oauth_secret are the access tokens that are received from the OAuth transaction. In this Sinatra method that uses the OmniAuth callback method, you can see how to parse the access tokens out of the response and use it to instantiate the Reshape client along with your pre-defined consumer tokens:
+
+```ruby
+get '/auth/:provider/callback' do
+  auth = request.env['omniauth.auth']
+  
+  client = Reshape::Client.new({
+		consumer_token: ENV['SHAPEWAYS_CONSUMER_TOKEN'], 
+		consumer_secret: ENV['SHAPEWAYS_CONSUMER_SECRET'], 
+		oauth_token: auth.credentials.token, 
+		oauth_secret: auth.credentials.secret
+	})  
+
+	erb "<pre>#{JSON.pretty_generate(client.materials)}</pre>"
+
+end
+```
+
+Check the examples directory for a full example using Sinatra.
+
+## Todo
+
+Add rspec tests for adding models and photos.
+
+
+## <a name="build"></a>Build Status
+[![Build Status](https://secure.travis-ci.org/phy5ics/reshape.png?branch=master)][travis]
+
+[travis]: http://travis-ci.org/phy5ics/omniauth-shapeways
+
+## <a name="dependencies"></a>Dependency Status
+[![Dependency Status](https://gemnasium.com/phy5ics/reshape.png?travis)][gemnasium]
+
+[gemnasium]: https://gemnasium.com/phy5ics/reshape
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2013 John Barton. See [LICENSE](https://github.com/phy5ics/reshape/blob/master/LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/examples/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'multi_json'
+gem 'omniauth-shapeways'
+gem 'reshape'

data/examples/config.ru

@@ -0,0 +1,45 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-shapeways'
+require 'reshape'
+
+# Get these keys from http://developer.shapeways.com
+ENV['CONSUMER_KEY'] = '61b13483fc0caf31f986026ce2add918d3fa9377'
+ENV['CONSUMER_SECRET'] = 'd0482b1653e67cfd25057c257eedd48a5cb8b66e'
+
+# To run this example:
+# $ bundle install
+# $ rackup -p 9293 config.ru &
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/shapeways'
+  end
+
+  get '/auth/:provider/callback' do
+    auth = request.env['omniauth.auth']
+    client = Reshape::Client.new({
+      consumer_token: ENV['SHAPEWAYS_CONSUMER_TOKEN'], 
+      consumer_secret: ENV['SHAPEWAYS_CONSUMER_SECRET'], 
+      oauth_token: auth.credentials.token, 
+      oauth_secret: auth.credentials.secret
+    })
+    materials = client.materials
+    
+    erb "<h1>#{params[:provider]}</h1>
+         <pre>#{JSON.pretty_generate(auth)}</pre>
+         <pre>#{JSON.pretty_generate(materials)}</pre>"
+  end
+
+  get '/auth/failure' do
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :shapeways, ENV['CONSUMER_KEY'], ENV['CONSUMER_SECRET']
+end
+
+run App.new

data/lib/faraday/response/raise_reshape_api_error.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+require 'multi_json'
+
+module Faraday
+  class Response::RaiseReshapeApiError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise Reshape::BadRequest, error_message(response)
+      when 401
+        raise Reshape::Unauthorized, error_message(response)
+      when 403
+        raise Reshape::Forbidden, error_message(response)
+      when 404
+        raise Reshape::NotFound, error_message(response)
+      when 406
+        raise Reshape::NotAcceptable, error_message(response)
+      when 422
+        raise Reshape::UnprocessableEntity, error_message(response)
+      when 500
+        raise Reshape::InternalServerError, error_message(response)
+      when 502
+        raise Reshape::BadGateway, error_message(response)
+      when 503
+        raise Reshape::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      message = if (body = response[:body]) && !body.empty?
+        if body.is_a?(String)
+          body = MultiJson.load(body, :symbolize_keys => true)
+        end
+        ": #{body[:error] || body[:message] || ''}"
+      else
+        ''
+      end
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
+    end
+  end
+end

data/lib/reshape/client/categories.rb

@@ -0,0 +1,15 @@
+module Reshape
+  class Client
+    module Categories
+      
+      def categories(options={}, raw=false)
+        get("/categories/#{api_version}", options, raw)
+      end
+      
+      def category(id, options={}, raw=false)
+        get("/categories/#{id}/#{api_version}", options, raw)
+      end
+      
+    end
+  end
+end

data/lib/reshape/client/materials.rb

@@ -0,0 +1,15 @@
+module Reshape
+  class Client
+    module Materials
+      
+      def materials(options={}, raw=false)
+        get("/materials/#{api_version}", options, raw)
+      end
+      
+      def material(id, options={}, raw=false)
+        get("/materials/#{id}/#{api_version}", options, raw)
+      end
+      
+    end
+  end
+end

data/lib/reshape/client/models.rb

@@ -0,0 +1,43 @@
+module Reshape
+  class Client
+    module Models
+      
+      def models(options={}, raw=false)
+        get("/models/#{api_version}", options, raw)
+      end
+      
+      def model(id, options={}, raw=false)
+        get("/models/#{id}/#{api_version}", options, raw)
+      end
+      
+      def add_model(file, name, rights, terms, options={}, raw=false)
+        post("/models/#{api_version}", options.merge(file: file, fileName: name, hasRightsToModel: rights, acceptTermsAndConditions: terms), raw)
+      end
+      
+      def delete_model(id, options={}, raw=false)
+        delete("/model/#{id}/#{api_version}", options, raw)
+      end
+      
+      def model_info(id, options={}, raw=false)
+        get("/models/#{id}/info/#{api_version}", options, raw)
+      end
+      
+      def update_model_info(id, options={}, raw=false)
+        put("/models/#{id}/info/#{api_version}", options, raw)
+      end
+      
+      def add_model_file(id, file, name, rights, terms, options={}, raw=false)
+        post("/models/#{id}/files/#{api_version}", options.merge(file: file, fileName: name, hasRightsToModel: rights, acceptTermsAndConditions: terms), raw)
+      end
+      
+      def model_file_by_version(id, fileVersion, options={}, raw=false)
+        get("/models/#{id}/files/#{fileVersion}/v1")
+      end
+      
+      def add_model_photo(id, file, options={}, raw=false)
+        post("/models/#{id}/photos/#{api_version}")
+      end
+      
+    end
+  end
+end

data/lib/reshape/client/orders.rb

@@ -0,0 +1,21 @@
+module Reshape
+  class Client
+    module Orders
+      
+      def cart(options={}, raw=false)
+        get("/orders/cart/#{api_version}", options, raw)
+      end
+      
+      def add_to_cart(model_id, material_id, quantity, options={}, raw=false)
+        options.merge!(
+          {
+            modelId: model_id,
+            materialId: material_id,
+            quantity: quantity
+          })
+        post("/orders/cart/#{api_version}", options, raw)
+      end
+      
+    end
+  end
+end

data/lib/reshape/client/price.rb

@@ -0,0 +1,22 @@
+module Reshape
+  class Client
+    module Price
+      
+      def price(volume, area, x_bound_min, x_bound_max, y_bound_min, y_bound_max, z_bound_min, z_bound_max, options={}, raw=false)
+        options.merge!(
+          {
+            volume: volume,
+            area: area,
+            xBoundMin: x_bound_min, 
+            xBoundMax: x_bound_max,
+            yBoundMin: y_bound_min,
+            yBoundMax: y_bound_max,
+            zBoundMin: z_bound_min,
+            zBoundMax: z_bound_max
+          })
+        post("/price/#{api_version}", options, raw)
+      end
+      
+    end
+  end
+end

data/lib/reshape/client/printers.rb

@@ -0,0 +1,15 @@
+module Reshape
+  class Client
+    module Printers
+      
+      def printers(options={}, raw=false)
+        get("/printers/#{api_version}", options, raw)
+      end
+      
+      def printer(id, options={}, raw=false)
+        get("/printers/#{id}/#{api_version}", options, raw)
+      end
+      
+    end
+  end
+end

data/lib/reshape/client.rb

@@ -0,0 +1,34 @@
+require 'reshape/configuration'
+require 'reshape/connection'
+require 'reshape/request'
+require 'reshape/error'
+require 'reshape/client/orders'
+require 'reshape/client/materials'
+require 'reshape/client/models'
+require 'reshape/client/printers'
+require 'reshape/client/price'
+require 'reshape/client/categories'
+
+module Reshape
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = Reshape.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+    
+    include Reshape::Configuration
+    include Reshape::Connection
+    include Reshape::Request
+    include Reshape::Client::Orders
+    include Reshape::Client::Materials
+    include Reshape::Client::Models
+    include Reshape::Client::Printers
+    include Reshape::Client::Price
+    include Reshape::Client::Categories
+    
+  end
+end

data/lib/reshape/configuration.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+require 'reshape/version'
+
+module Reshape
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :api_version,
+      :api_endpoint,
+      :web_endpoint,
+      :proxy,
+      :consumer_token,
+      :consumer_secret,
+      :consumer_options,
+      :oauth_token,
+      :oauth_secret,
+      :response_format,
+      :user_agent].freeze
+
+    DEFAULT_ADAPTER = Faraday.default_adapter
+    DEFAULT_API_VERSION = 'v1'
+    DEFAULT_API_ENDPOINT = 'http://api.shapeways.com/'
+    DEFAULT_WEB_ENDPOINT = 'http://www.shapeways.com/'
+    DEFAULT_USER_AGENT = "Reshape Rubygem #{Reshape::VERSION}".freeze
+    DEFAULT_RESPONSE_FORMAT = 'json'
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def api_endpoint=(value)
+      @api_endpoint = File.join(value, "")
+    end
+
+    def web_endpoint=(value)
+      @web_endpoint = File.join(value, "")
+    end
+
+    def reset
+      self.adapter = DEFAULT_ADAPTER
+      self.api_version = DEFAULT_API_VERSION
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+      self.web_endpoint = DEFAULT_WEB_ENDPOINT
+      self.proxy = nil
+      self.consumer_token = nil
+      self.consumer_secret = nil
+      self.oauth_token = nil
+      self.oauth_secret = nil
+      self.response_format = DEFAULT_RESPONSE_FORMAT
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/reshape/connection.rb

@@ -0,0 +1,38 @@
+require 'faraday_middleware'
+require 'faraday/response/raise_reshape_api_error'
+
+module Reshape
+  module Connection
+    private
+    def oauth_data
+      {
+        consumer_key: @consumer_token,
+        consumer_secret: @consumer_secret,
+        token: @oauth_token,
+        token_secret: @oauth_secret
+      }
+    end
+    
+    def connection(raw=false, force_urlencoded=false)
+      url = "#{Reshape.api_endpoint}"
+
+      options = {
+        url: url,
+        proxy: proxy,
+        ssl: { verify: false },
+      }
+      
+      connection = Faraday.new(options) do |builder|
+        builder.use Faraday::Response::RaiseReshapeApiError
+        builder.request :json
+        builder.request :oauth, oauth_data
+        unless raw
+          builder.use FaradayMiddleware::Mashify
+          builder.use FaradayMiddleware::ParseJson
+        end
+        builder.adapter *adapter
+      end
+      connection
+    end
+  end
+end

data/lib/reshape/error.rb

@@ -0,0 +1,31 @@
+module Reshape
+  # Custom error class for rescuing from all Shapeways errors
+  class Error < StandardError; end
+
+  # Raised when Shapeways returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when Shapeways returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when Shapeways returns a 403 HTTP status code
+  class Forbidden < Error; end
+
+  # Raised when Shapeways returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Raised when Shapeways returns a 406 HTTP status code
+  class NotAcceptable < Error; end
+
+  # Raised when Shapeways returns a 422 HTTP status code
+  class UnprocessableEntity < Error; end
+
+  # Raised when Shapeways returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Raised when Shapeways returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Raised when Shapeways returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end

data/lib/reshape/request.rb

@@ -0,0 +1,42 @@
+require 'multi_json'
+
+module Reshape
+  module Request
+    def get(path, options={}, raw=false, force_urlencoded=false)
+      request(:get, path, options, raw, force_urlencoded)
+    end
+    
+    def post(path, options={}, raw=false, force_urlencoded=false)
+      request(:post, path, options, raw, force_urlencoded)
+    end
+
+    def put(path, options={}, raw=false, force_urlencoded=false)
+      request(:put, path, options, raw, force_urlencoded)
+    end
+
+    def delete(path, options={}, raw=false, force_urlencoded=false)
+      request(:delete, path, options, raw, force_urlencoded)
+    end
+
+    private
+
+    def request(method, path, options, raw, force_urlencoded)
+      response = connection(raw, force_urlencoded).send(method) do |request|
+        case method
+        when :delete, :get
+          request.url(path, options)
+        when :patch, :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+
+      if raw
+        response
+      else
+        response.body
+      end
+    end
+
+  end
+end

data/lib/reshape/version.rb

@@ -0,0 +1,3 @@
+module Reshape
+  VERSION = '0.1'
+end

data/lib/reshape.rb

@@ -0,0 +1,20 @@
+require 'reshape/version'
+require 'reshape/configuration'
+require 'reshape/client'
+require 'reshape/error'
+
+module Reshape
+  extend Configuration
+  class << self
+    # Alias for Reshape::Client.new
+    #
+    # @return [Reshape::Client]
+    def new(options={})
+      Reshape::Client.new(options)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/reshape.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reshape/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "reshape"
+  gem.version       = Reshape::VERSION
+  gem.authors       = ["John Barton"]
+  gem.email         = ["jb@phy5ics.com"]
+  gem.description   = %q{A client for the Shapeways 3D printing API.}
+  gem.summary       = %q{A client for the Shapeways 3D printing API.}
+  gem.homepage      = "https://github.com/phy5ics/reshape"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'faraday', '~> 0.8.4'
+  gem.add_dependency 'faraday_middleware', '~> 0.8.4'
+  gem.add_dependency 'hashie', '~> 1.2'
+  gem.add_dependency 'multi_json', '~> 1.3'
+  gem.add_dependency 'simple_oauth'
+  
+  gem.add_development_dependency 'json'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  
+end