slash3d 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f293a2b373781f1bab3fbb20331a0cead2fb13de
+  data.tar.gz: 561d431cebe0cbfd8e6d652a7670378f90dd94e2
+SHA512:
+  metadata.gz: 2b1f797a59959d09aa7412146c8c81419d7da22f19ca151bca9a03e430b9153182ae34df0c87229b69fd58eb6fae878cde4c7034951c8e215fa90245ce5863b8
+  data.tar.gz: 7c5162c6bb6f06b4e6e9aae9506c819880cb751c6e63d57f3cb1f633d5ee49a360fcbfb85e1057917a9a3bb19041eacbef798228e35169518fbd1e66569999c5

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slash3d.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sunny Ripert
+
+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,107 @@
+Ruby gem to access [3D Slash](https://www.3dslash.net/)'s API
+=============================================================
+
+Here be dragons
+---------------
+
+This gem has not yet been tested in production. But it works. Probably.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```rb
+gem "slash3d"
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+
+Configuration
+-------------
+
+```rb
+Slash3D.configure do |c|
+  c.partner_code = "foobar"
+  c.api_key = "d4he4fae262352e4…"
+end
+```
+
+You should get the partner code and API key by asking 3D Slash.
+
+
+Usage
+-----
+
+### Get an Iframe url
+
+```rb
+iframe = Slash3D::Iframe.new(
+  source: <url of stl or 3d slash id>,
+  redirect_url: <your url>,
+)
+
+iframe.url #=> "https://www.3dslash.net/slash.php?…"
+iframe.content_id #=> "4c5fd2b2aa423d430f22ba940f4e28f7060fc39b2e44…"
+```
+
+You can then use it in your page:
+
+```html
+<iframe frameborder="0" src="<%= iframe.url %>"></iframe>
+```
+
+### Handle the POST
+
+Once the user has clicked "export", a `POST` request will be sent to the
+`redirect_url` you have given.
+
+To get URLs from these parameters, pass them to a `Response`:
+
+```rb
+response = Slash3D::Response.new(params)
+```
+
+You can get temporary URLs:
+
+```rb
+response.stl_url # => "https://www.3dslash.net/…"
+response.thumbnail_url # => "https://www.3dslash.net/…"
+response.slash3d_url # => "https://www.3dslash.net/…"
+```
+
+And the full URL to the creation:
+
+```rb
+response.permanent_url # => "https://www.3dslash.net/…"
+```
+
+For thumbnails you can specify size (defaults to 192x192):
+
+```rb
+response.thumbnail_url(width: 42, height: 42) # => "https://www.3dslash.net/…"
+```
+
+You can store this model's uid to use it as a `source` the next time
+you make an `Iframe`.
+
+```rb
+response.uid # => "d430f22ba940f4e28f7060…"
+```
+
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/sunny/slash3d/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Launch specs (`bundle exec rspec`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/slash3d/configuration.rb

@@ -0,0 +1,16 @@
+module Slash3D
+  # Global configuration options
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :partner_code
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/slash3d/iframe.rb

@@ -0,0 +1,47 @@
+require "active_support/core_ext/object/to_query"
+require "securerandom"
+
+module Slash3D
+  # Represent an Iframe to build a model with 3D Slash
+  class Iframe
+    def initialize(content_id: nil,
+                   source: nil,
+                   redirect_url: nil)
+      @content_id = content_id
+      @source = source
+      @redirect_url = redirect_url
+    end
+
+    def content_id
+      @content_id ||= SecureRandom.hex(32)
+    end
+
+    def url
+      parameters = {
+        partner: Slash3D.configuration.partner_code,
+        content: content_id,
+        src: source,
+        redirect: redirect_url,
+        sign: signature,
+      }
+
+      "https://www.3dslash.net/slash.php?" + parameters.to_query
+    end
+
+    private
+
+    def signature
+      signature_values = [
+        Slash3D.configuration.api_key,
+        Slash3D.configuration.partner_code,
+        content_id,
+        source,
+        redirect_url,
+      ]
+
+      Digest::SHA256.hexdigest(signature_values.join("|"))
+    end
+
+    attr_reader :source, :redirect_url
+  end
+end

data/lib/slash3d/response.rb

@@ -0,0 +1,66 @@
+require "active_support/core_ext/object/to_query"
+require "securerandom"
+require "net/http"
+
+module Slash3D
+  # Parse a 3D Slash POST response and extract URLs to the new model
+  class Response
+    attr_reader :content
+
+    def initialize(params)
+      @api = params[:api]
+      @content = params[:content]
+      @uid = params[:dslashUID]
+      @nonce = params[:nonce]
+    end
+
+    def stl_url
+      action_url("stl")
+    end
+
+    def thumbnail_url(width: nil, height: nil)
+      action_url("thumbnail", width: width, height: height)
+    end
+
+    def slash3d_url
+      action_url("3dslash")
+    end
+
+    def permanent_url
+      url = URI.parse(action_url("url"))
+      Net::HTTP.get_response(url).body
+    end
+
+
+    private
+
+    attr_reader :api, :nonce, :uid
+
+    def action_url(action, width: nil, height: nil)
+      params = {
+        action: action,
+        :alias => uid,
+        nonce: nonce,
+        partner: Slash3D.configuration.partner_code,
+        sign: signature(action),
+      }
+
+      params[:width] = width if width
+      params[:height] = height if height
+
+      "#{api}?#{params.to_query}"
+    end
+
+    def signature(action)
+      signature_values = [
+        Slash3D.configuration.api_key,
+        Slash3D.configuration.partner_code,
+        nonce,
+        uid,
+        action,
+      ]
+
+      Digest::SHA256.hexdigest(signature_values.join("|"))
+    end
+  end
+end

data/lib/slash3d/version.rb

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

data/lib/slash3d.rb

@@ -0,0 +1,4 @@
+require "slash3d/configuration"
+require "slash3d/iframe"
+require "slash3d/version"
+require "slash3d/response"

data/slash3d.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slash3d/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slash3d"
+  spec.version       = Slash3D::VERSION
+  spec.authors       = ["Sunny Ripert"]
+  spec.email         = ["sunny@sunfox.org"]
+  spec.summary       = "Access 3D Slash's API"
+  # spec.description   = "TODO: Write a longer description. Optional."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  # spec.add_dependency "securerandom"
+
+  # Tasks for gem development
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  # Specs
+  spec.add_development_dependency "rspec"
+
+  # Block HTTP connections in specs
+  spec.add_development_dependency "webmock"
+end

data/spec/iframe_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require "slash3d/iframe"
+
+module Slash3D
+  describe Iframe do
+    let(:iframe) { described_class.new(options) }
+    let(:options) { { source: "http://source-url",
+                      redirect_url: "http://redirect-url" } }
+
+    describe "#url" do
+      before do
+        allow(iframe).to receive(:content_id) { "c97ff01cdf0fca07a33dce9" }
+      end
+
+      it "returns a full url to 3dslash" do
+        url = "https://www.3dslash.net/slash.php" \
+              "?content=c97ff01cdf0fca07a33dce9" \
+              "&partner=test_partner_code" \
+              "&redirect=http%3A%2F%2Fredirect-url" \
+              "&sign=4c5fd2b2aa423d430f22ba940f4e28f7060fc39b2e44a70e656f74b94a38859c" \
+              "&src=http%3A%2F%2Fsource-url"
+
+        expect(iframe.url).to eq(url)
+      end
+    end
+
+    describe "#content_id" do
+      it "generates a random hex" do
+        expect(iframe.content_id).to match(/^[0-9a-f]{10,256}$/)
+      end
+
+      it "is memoized" do
+        expect(iframe.content_id).to eq(iframe.content_id)
+      end
+
+      context "when given in the options" do
+        let(:options) { { content_id: "f00" } }
+
+        it "returns the same value" do
+          expect(iframe.content_id).to eq("f00")
+        end
+      end
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+require "slash3d/response"
+
+module Slash3D
+  describe Response do
+    let(:response) { described_class.new(params) }
+    let(:params) { { content: "f004221",
+                     dslashUID: "b484221",
+                     api: "https://api.3dslash.net/",
+                     nonce: "e4f57b89" } }
+
+    describe "#stl_url" do
+      it "returns a full url to 3dslash" do
+        url = "https://api.3dslash.net/" \
+              "?action=stl" \
+              "&alias=b484221" \
+              "&nonce=e4f57b89" \
+              "&partner=test_partner_code" \
+              "&sign=d9c3924d0fb3e428034b6918f3d4d9f206e034baf7c25dbc602344ed60bd0d6d"
+
+        expect(response.stl_url).to eq(url)
+      end
+    end
+
+    describe "#thumbnail_url" do
+      it "returns a full url to 3dslash" do
+        url = "https://api.3dslash.net/" \
+              "?action=thumbnail" \
+              "&alias=b484221" \
+              "&nonce=e4f57b89" \
+              "&partner=test_partner_code" \
+              "&sign=26ce6e91823e9cfe08ca520031dd417c2a928c61e62b2153a978787bfe813c62"
+
+        expect(response.thumbnail_url).to eq(url)
+      end
+
+      it "adds the given width and height to the url" do
+        url = "https://api.3dslash.net/" \
+              "?action=thumbnail" \
+              "&alias=b484221" \
+              "&height=456" \
+              "&nonce=e4f57b89" \
+              "&partner=test_partner_code" \
+              "&sign=26ce6e91823e9cfe08ca520031dd417c2a928c61e62b2153a978787bfe813c62" \
+              "&width=123"
+
+        expect(response.thumbnail_url(width: 123, height: 456)).to eq(url)
+      end
+    end
+
+    describe "#slash3d_url" do
+      it "returns a full url to 3dslash" do
+        url = "https://api.3dslash.net/" \
+              "?action=3dslash" \
+              "&alias=b484221" \
+              "&nonce=e4f57b89" \
+              "&partner=test_partner_code" \
+              "&sign=06de2763db0fbef294770827d9f5ddb613bc9c717a28381a44992ea36a515f29"
+
+        expect(response.slash3d_url).to eq(url)
+      end
+    end
+
+    describe "#permanent_url" do
+      it "returns the permanent url to a 3dslash creation" do
+        url = "https://api.3dslash.net/" \
+              "?action=url" \
+              "&alias=b484221" \
+              "&nonce=e4f57b89" \
+              "&partner=test_partner_code" \
+              "&sign=f3b529b43c4591de2f33049f7cd572f3faa024f43c0e75aef357b87daa5db2ca"
+
+        stub_request(:get, url)
+          .to_return(body: "https://foo.com")
+
+        expect(response.permanent_url).to eq("https://foo.com")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "webmock/rspec"
+
+require "slash3d/configuration"
+
+Slash3D.configure do |c|
+  c.partner_code = "test_partner_code"
+  c.api_key = "test_api_key"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: slash3d
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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'
+description: 
+email:
+- sunny@sunfox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slash3d.rb
+- lib/slash3d/configuration.rb
+- lib/slash3d/iframe.rb
+- lib/slash3d/response.rb
+- lib/slash3d/version.rb
+- slash3d.gemspec
+- spec/iframe_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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 3D Slash's API
+test_files:
+- spec/iframe_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb