authentise 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a9cba594afbbcd29be2d1b3c1f29627e5ce6a95
+  data.tar.gz: 36659769fc84a3b1af0a4578476414654ebe0ddf
+SHA512:
+  metadata.gz: e34a7b309ccc01ff79c2303f91e25ed6030a3987ef9b81c46bf5adcfd1747c635580aecd1395d7eabf943a78fc66d731d9b664f16f8bd45796696abc3e3e7d01
+  data.tar.gz: 06b4505e6f8b8ce98e7079ef647541bf0064bcb1538eb35fa3f63a028d6d52df5651cd32686cad7b2e784d86b75786e4f6efe72806dcbf4def069241bd6056d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 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,67 @@
+Ruby gem to access Authentise API v3
+====================================
+
+See http://docs.dev-auth.com/
+
+Example usage
+-------------
+
+```rb
+Authentise.configure do |c|
+  c.secret_partner_key = "ZSBzaG9y-dCB2ZWhl-bWVuY2Ug-b2YgYW55-IGNhcm5h-bCB=="
+  c.use_ssl = false
+end
+
+upload = Authentise::Upload.new(
+  stl_file: File.new("example.stl", "rb"),
+  email: "example@example.com",
+  cents: 2_00,
+  currency: "EUR"
+)
+
+upload.token
+# => "33b41d6e80d4918cfff768185d1d31a6"
+
+upload.link_url
+# => "https://widget.sendshapes.com/?token=33b41d6e80d4918cfff768185d1d31a6"
+
+upload.status
+# => {
+#  printing_job_status_name: "warming_up",
+#  printing_percentage: 0,
+#  minutes_left: 21,
+#  message: ""
+# }
+```
+
+Install
+-------
+
+Add the following line to your Gemfile:
+
+```rb
+gem "authentise"
+```
+
+
+Development
+-----------
+
+For local development, please install the `bundler` gem then:
+
+```sh
+$ bundle
+```
+
+To launch specs:
+
+```sh
+$ rake
+```
+
+
+License
+-------
+
+Created by Sunny Ripert for [Cults.](https://cults3d.com),
+licensed under the MIT License.

data/Rakefile

@@ -0,0 +1,11 @@
+# Bundler
+require 'bundler/gem_tasks'
+
+# Specs
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = Dir.glob("spec/**/*_spec.rb")
+end
+
+task default: :test

data/lib/authentise.rb

@@ -0,0 +1 @@
+require "authentise/upload"

data/lib/authentise/api.rb

@@ -0,0 +1,92 @@
+require "json"
+require "rest-client"
+require "authentise/configuration"
+
+module Authentise
+  module API
+    class Error < RuntimeError; end
+
+    CREATE_TOKEN_PATH = "api3/api_create_partner_token"
+    UPLOAD_FILE_PATH = "api3/api_upload_partner_stl"
+    STATUS_PATH = "api3/api_get_partner_print_status"
+
+    module_function
+
+    def create_token
+      url = "#{host}/#{CREATE_TOKEN_PATH}"
+      params = {
+        api_key: Authentise.configuration.secret_partner_key
+      }
+      response = RestClient.get(url, params: params)
+      data = parse(response)
+      data["token"]
+    end
+
+    def upload_file(file: nil, token: nil, email: nil, cents: nil, currency: "USD")
+      url = "#{host}/#{UPLOAD_FILE_PATH}"
+      params = {
+        api_key: Authentise.configuration.secret_partner_key,
+        token: token,
+        receiver_email: email,
+        print_value: cents,
+        print_value_currency: currency,
+        stl_file: file
+      }
+      response = RestClient.post(url, params, accept: :json)
+      data = parse(response)
+
+      if Authentise.configuration.use_ssl
+        data["ssl_token_link"]
+      else
+        data["token_link"]
+      end
+    end
+
+    # Returns a status hash for the given token if the print has started.
+    # /!\ Do not call this more than once every 15 seconds.
+    #
+    # `:printing_job_status` can be one of:
+    # - `warming_up`
+    # - `printing`
+    # - `failure`
+    # - `success`
+    # - `confirmed_success`
+    # - `confirmed_failure`
+    def get_status(token: nil)
+      url = "#{host}/#{STATUS_PATH}"
+      params = {
+        api_key: Authentise.configuration.secret_partner_key,
+        token: token
+      }
+      response = RestClient.get(url, params: params)
+      data = parse(response)
+      {
+        printing_job_status_name: data["printing_job_status_name"].downcase,
+        printing_percentage: data["printing_percentage"],
+        minutes_left: data["minutes_left"],
+        message: data["message"]
+      }
+    end
+
+    private_class_method
+
+    def parse(response)
+      json = JSON.parse(response)
+      if json["status"] and json["status"]["code"] != "ok"
+        fail Error, json["status"]["extended_description"]
+      elsif json["data"]
+        json["data"]
+      else
+        fail Error, "JSON with no data: #{response}"
+      end
+    end
+
+    def host
+      if Authentise.configuration.use_ssl
+        "https://widget.sendshapes.com:3443"
+      else
+        "http://widget.sendshapes.com:3000"
+      end
+    end
+  end
+end

data/lib/authentise/configuration.rb

@@ -0,0 +1,19 @@
+module Authentise
+  class Configuration
+    attr_accessor :secret_partner_key
+    attr_accessor :use_ssl
+
+    def initialize
+      @use_ssl = true
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/authentise/upload.rb

@@ -0,0 +1,35 @@
+require "authentise/api"
+
+module Authentise
+  class Upload
+    attr_reader :stl_file, :email, :cents, :currency
+
+    def initialize(stl_file: nil,
+                   email: nil,
+                   cents: nil,
+                   currency: nil,
+                   token: nil)
+      @stl_file = stl_file
+      @email = email
+      @cents = cents
+      @currency = currency
+      @token = token
+    end
+
+    def token
+      @token ||= API.create_token
+    end
+
+    def link_url
+      @upload_url ||= API.upload_file(file: stl_file,
+                                      token: token,
+                                      email: email,
+                                      cents: cents,
+                                      currency: currency)
+    end
+
+    def status
+      @status ||= API.get_status(token: token)
+    end
+  end
+end

data/lib/authentise/version.rb

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

data/spec/api_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe Authentise::API do
+  describe ".create_token" do
+    it "returns a token from the API" do
+      stub_request(:get, "https://widget.sendshapes.com:3443/api3/api_create_partner_token?api_key=test")
+        .to_return(status: 200, body: '{"data":{"token":"meh"}}')
+
+      Authentise::API.create_token.must_equal "meh"
+    end
+  end
+
+  describe ".upload_file" do
+    it "returns a URL" do
+      api_url = "https://widget.sendshapes.com:3443/api3/api_upload_partner_stl"
+      request_body = { "api_key" => "test",
+                       "print_value" => "100",
+                       "print_value_currency" => "EUR",
+                       "receiver_email" => "example@example.com",
+                       "stl_file" => "",
+                       "token"=>"meh"}
+      request_headers = { "Accept" => "application/json",
+                          "Accept-Encoding" => "gzip, deflate",
+                          "Content-Length" => "110",
+                          "Content-Type" => "application/x-www-form-urlencoded",
+                          "User-Agent" => "Ruby"}
+
+      response_body = '{"data":{"ssl_token_link":"https://bah"}}'
+
+      stub_request(:post, api_url)
+        .with(body: request_body, headers: request_headers)
+        .to_return(status: 200, body: response_body)
+
+      returned = Authentise::API.upload_file(file: nil,
+                                             token: "meh",
+                                             email: "example@example.com",
+                                             cents: 100,
+                                             currency: "EUR")
+      returned.must_equal "https://bah"
+    end
+
+    it "uses the non-ssl link if use_ssl is false" do
+      api_url = "http://widget.sendshapes.com:3000/api3/api_upload_partner_stl"
+      stub_request(:post, api_url)
+        .to_return(body: '{"data":{"token_link":"http://bah"}}')
+
+      Authentise.configuration.stub :use_ssl, false do
+        returned = Authentise::API.upload_file(file: nil,
+                                               token: "meh",
+                                               email: "example@example.com",
+                                               cents: 100,
+                                               currency: "EUR")
+        returned.must_equal "http://bah"
+      end
+    end
+  end
+
+  describe ".get_status" do
+    it "returns a status hash" do
+      api_url = "https://widget.sendshapes.com:3443/api3/api_get_partner_print_status?api_key=test&token=meh"
+      request_body = { "api_key" => "test",
+                       "print_value" => "100",
+                       "print_value_currency" => "EUR",
+                       "receiver_email" => "example@example.com",
+                       "stl_file" => "",
+                       "token"=>"meh"}
+      response_body = {
+        status: { code: "ok" },
+        data: {
+          printing_job_status_name: "WARMING_UP",
+          printing_percentage: 20,
+          minutes_left: nil,
+          message: nil,
+        }
+      }
+
+      stub_request(:get, api_url)
+        .to_return(status: 200, body: response_body.to_json)
+
+      returned = Authentise::API.get_status(token: "meh")
+      returned.must_equal(
+        printing_job_status_name: "warming_up",
+        printing_percentage: 20,
+        minutes_left: nil,
+        message: nil
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "minitest/autorun"
+require "webmock/minitest"
+
+require "authentise"
+
+Authentise.configure do |c|
+  c.secret_partner_key = "test"
+end

data/spec/upload_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Authentise::Upload do
+  let(:upload) {
+    Authentise::Upload.new(email: "example@example.com",
+                                     currency: "EUR",
+                                     cents: 1_00)
+  }
+
+  describe "#token" do
+    it "returns a token from the API" do
+      Authentise::API.stub :create_token, "meh" do
+        upload.token.must_equal "meh"
+      end
+    end
+  end
+
+  describe '#link_url' do
+    it "returns a token from the API" do
+      upload.stub :token, "meh" do
+        Authentise::API.stub :upload_file, "https://bah" do
+          upload.link_url.must_equal "https://bah"
+        end
+      end
+    end
+  end
+
+  describe '#status' do
+    it "returns a status from the API" do
+      upload.stub :token, "meh" do
+        Authentise::API.stub :upload_file, "stats…" do
+          upload.link_url.must_equal "stats…"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: authentise
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: 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'
+description: Access Authentise's 3D-Printing streaming API
+email:
+- sunny@sunfox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/authentise.rb
+- lib/authentise/api.rb
+- lib/authentise/configuration.rb
+- lib/authentise/upload.rb
+- lib/authentise/version.rb
+- spec/api_spec.rb
+- spec/spec_helper.rb
+- spec/upload_spec.rb
+homepage: http://github.com/sunny/authentise
+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 the Authentise v3 API
+test_files:
+- spec/api_spec.rb
+- spec/spec_helper.rb
+- spec/upload_spec.rb