imaterialise 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 226e89bd1af711176ae72e57a13fb7e1bcbd5431
+  data.tar.gz: 064da1ccfe88098f95180b4aed7dc77718022224
+SHA512:
+  metadata.gz: 7ad7bd946d55522de53be420b4bc985ffe78246c96b2dbae0c0d3c02be4bfb822ac856cf13c6bcbf5910021fdc5e352e37ce3f1b3406d93d0b2bf914ed60e5dd
+  data.tar.gz: 32d835cd021cdb6e7b5a8a61d08d9866bd3a3b390e1ad5aedb69aa6a288bc170d84ad95dc7fb6547d24cfd3416cfe37f4ed666c8dd429cab3737b60cb46ca540

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Sunny Ripert
+
+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,61 @@
+Ruby gem to access i.materialise's API
+======================================
+
+Configuration
+-------------
+
+```rb
+Imaterialise.configure do |c|
+  c.tool_id = "YOUR-TOOL-ID-HERE"
+
+  # Use the sandbox environment during development
+  c.sandbox = true
+end
+```
+
+Usage
+-----
+
+### 3D Print Lab Connection
+
+```rb
+model = Imaterialise::Connection.new(file_url: "/path/to/example.stl"),
+                                     currency: "eur")
+model.upload
+model.url # => "http://i.materialise.com/UploadRouter?modelID=1234-5678-1234-1…"
+```
+
+You can redirect your users to the given URL.
+
+
+Install
+-------
+
+Add the following line to your Gemfile if you are using the `bundler` gem:
+
+```rb
+gem "imaterialise", github: "sunny/imaterialise"
+```
+
+
+Development
+-----------
+
+To launch specs:
+
+```sh
+$ rake
+```
+
+
+License
+-------
+
+Created by Sunny Ripert for [Cults.](https://cults3d.com),
+licensed under the MIT License.
+
+
+See also
+--------
+
+- https://i.materialise.com/api/

data/Rakefile

@@ -0,0 +1,14 @@
+# Bundler
+require "bundler/gem_tasks"
+
+# Specs
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+# Console
+desc "Open a pry session preloaded with this library"
+task :console do
+  sh "pry --gem -r ./console.rb"
+end
+
+task default: :spec

data/console.rb

@@ -0,0 +1,11 @@
+require "pry"
+require "net-http-spy"
+Net::HTTP.http_logger_options = { verbose: true }
+
+require "imaterialise"
+
+Imaterialise.configure do |c|
+  c.api_code = "test-api-code"
+  c.tool_id = "test-tool-id"
+  c.sandbox = true
+end

data/lib/imaterialise.rb

@@ -0,0 +1,2 @@
+require "imaterialise/configuration"
+require "imaterialise/connection"

data/lib/imaterialise/api.rb

@@ -0,0 +1,29 @@
+require "rest_client"
+
+module Imaterialise
+  # Namespace for the API.
+  module API
+    # JSON HTTP errors from the API.
+    class APIError < StandardError
+      def initialize(http_code, body)
+        json = JSON.parse(body)
+        error = json && json["error"]
+        if error
+          super "#{http_code}: #{error['message']} (code #{error['code']})"
+        else
+          super "#{http_code}: #{body}"
+        end
+      end
+    end
+
+    module_function
+
+    def host
+      if Imaterialise.configuration.sandbox
+        "https://imatsandbox.materialise.net"
+      else
+        "https://i.materialise.com"
+      end
+    end
+  end
+end

data/lib/imaterialise/api/connection.rb

@@ -0,0 +1,35 @@
+require "imaterialise/api"
+
+module Imaterialise
+  module API
+    # 3D Print Lab Connection API
+    # See http://i.materialise.com/api/docs/3d-print-lab-connection-api/
+    module Connection
+      module_function
+
+      def post(model)
+        url = "#{API.host}/upload"
+        body = post_body(model)
+
+        RestClient.post(url, body, accept: :json) do |response, _, _|
+          case response.code
+          when 302
+            { url: response.headers[:location] }
+          else
+            fail APIError.new(response.code, response.body)
+          end
+        end
+      end
+
+      def post_body(model)
+        {
+          useAjax: true,
+          forceEmbedding: false,
+          plugin: Imaterialise.configuration.tool_id,
+          fileUrl: model.file_url,
+          currency: model.currency.upcase,
+        }
+      end
+    end
+  end
+end

data/lib/imaterialise/configuration.rb

@@ -0,0 +1,24 @@
+# Settings for connecting to the API.
+module Imaterialise
+  # Container for configuration settings.
+  class Configuration
+    attr_accessor :api_code
+    attr_accessor :tool_id
+    attr_accessor :sandbox
+
+    def initialize
+      @api_code = ""
+      @tool_id = ""
+      @sandbox = false
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/imaterialise/connection.rb

@@ -0,0 +1,20 @@
+require "imaterialise/api/connection"
+
+module Imaterialise
+  # Represents a 3D Print Lab Connection between a model and imaterialise.
+  #
+  # See README.md for usage.
+  class Connection
+    attr_reader :file_url, :currency, :url
+
+    def initialize(file_url:, currency:)
+      @file_url = file_url
+      @currency = currency
+    end
+
+    def upload
+      result = API::Connection.post(self)
+      @url = result.fetch(:url)
+    end
+  end
+end

data/lib/imaterialise/version.rb

@@ -0,0 +1,3 @@
+module Imaterialise
+  VERSION = "0.0.1"
+end

data/spec/api/connection_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+module Imaterialise
+  module API
+    describe Connection do
+      let(:connection) {
+        Imaterialise::Connection.new(file_url: "http://example.com/foo.stl",
+                                     currency: "eur")
+      }
+
+      describe ".post" do
+        subject { described_class.post(connection) }
+
+        it "returns a hash" do
+          expected_body = {
+            "currency" => "EUR",
+            "fileUrl" => "http://example.com/foo.stl",
+            "forceEmbedding" => "false",
+            "plugin" => "test-tool-id",
+            "useAjax" => "true",
+          }
+          expected_headers = {
+            "Accept" => "application/json",
+          }
+          response_headers = {
+            "Location" => "http://i.materialise.com/foo.stl",
+          }
+
+          stub_request(:post, "https://imatsandbox.materialise.net/upload")
+            .with(body: expected_body, headers: expected_headers)
+            .to_return(status: 302, headers: response_headers)
+
+          expect(subject).to eq(url: "http://i.materialise.com/foo.stl")
+        end
+      end
+    end
+  end
+end

data/spec/connection_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Imaterialise::Connection do
+  subject {
+    described_class.new(file_url: "http://example.com/foo.stl",
+                        currency: "eur")
+  }
+
+  it "has a file url" do
+    expect(subject.file_url).to eq("http://example.com/foo.stl")
+  end
+
+  it "has a currency" do
+    expect(subject.currency).to eq("eur")
+  end
+
+  context "on upload" do
+    let(:upload_response) { { url: "http://test" } }
+    before do
+      allow(Imaterialise::API::Connection).to receive(:post) { upload_response }
+    end
+
+    it { expect(subject.upload).to be_truthy }
+
+    it "calls the API correctly" do
+      subject.upload
+      expect(Imaterialise::API::Connection).to have_received(:post)
+        .with(subject)
+    end
+
+    it "sets the url" do
+      subject.upload
+      expect(subject.url).to eq("http://test")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "webmock/rspec"
+
+# Cut off the interwebs
+WebMock.disable_net_connect!(allow_localhost: true)
+
+
+require "imaterialise"
+
+Imaterialise.configure do |c|
+  c.api_code = "test-api-code"
+  c.tool_id = "test-tool-id"
+  c.sandbox = true
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: imaterialise
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rake
+  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: rspec
+  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: 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'
+description: Upload 3D Models on imaterialise's service
+email:
+- sunny@cults3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- console.rb
+- lib/imaterialise.rb
+- lib/imaterialise/api.rb
+- lib/imaterialise/api/connection.rb
+- lib/imaterialise/configuration.rb
+- lib/imaterialise/connection.rb
+- lib/imaterialise/version.rb
+- spec/api/connection_spec.rb
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sunny/imaterialise
+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
+signing_key: 
+specification_version: 4
+summary: Access imaterialise's API
+test_files:
+- spec/api/connection_spec.rb
+- spec/connection_spec.rb
+- spec/spec_helper.rb