renuo-upload 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 009244123070df77e6b3e567320a0a38c46ca4b9
+  data.tar.gz: 57673e36ef3be9ce90dfa480697255d2c828b3b7
+SHA512:
+  metadata.gz: 9e49c02f52da6ef6c49bfda7c99a626a9c753f3b22f141f60ed69c651a9afbe22bb937f2f87d5ca446b5442300aedfcde0b6f40aa8ef721aa3086a086a7c9809
+  data.tar.gz: 6673533fb273bc7519a2940a0badd4c6416aff2bed423d35cf90459003068754da7a22d31fe3d6e1fb8a1ae7a0501fef7056579395f87a17e3b5a95ee4e3ec96

data/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+.idea
+.ruby-version
+*.gem
+Gemfile.lock
+.bundle

data/.reek

@@ -0,0 +1,15 @@
+---
+IrresponsibleModule:
+  enabled: false
+Attribute:
+  enabled: false
+
+exclude_paths:
+  - tmp
+  - spec
+  - vendor
+  - log
+  - coverage
+  - config
+  - bin
+  - db/migrate

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/NonNilCheck:
+  IncludeSemanticChanges: true
+
+Style/FileName:
+  Exclude:
+  - 'Gemfile.local.rb'
+  - 'Gemfile.local.example.rb'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/bundle/**/*'
+    - 'lib/renuo-upload.rb'

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+addons:
+  apt:
+    packages:
+    - zsh
+bundler_args: --jobs=3 --retry=3
+cache:
+  bundler: true
+  apt: true
+  directories:
+    - coverage
+before_install:
+  - export TZ=Europe/Zurich
+before_script:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+script: bin/setup
+notifications:
+  email:
+    on_success: change
+    on_failure: always

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 0.0.1
+
+* initial release

data/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing
+
+### We love pull requests. Here's a quick guide.
+
+Fork, then clone the repo:
+```
+git clone git@github.com:your-username/renuo-upload-ruby.git
+```
+
+Set up your machine:
+```
+git checkout -b your-branch-name
+bin/setup
+```
+
+Make sure the tests pass:
+```
+bin/check
+```
+
+Make your change. Add tests for your change. Make the tests pass:
+```
+bin/check
+```
+
+Push to your fork and [submit a pull request][pr].
+```
+git push origin your-branch-name
+```
+
+[pr]: https://github.com/renuo/renuo-upload-ruby/compare/
+
+At this point you're waiting on us. We like to at least comment on pull requests within three business days
+(and, typically, one business day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Write a [good commit message][commit].
+
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Renuo GmbH
+
+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,61 @@
+[![Build Status](https://travis-ci.org/renuo/renuo-upload-ruby.svg?branch=master)](https://travis-ci.org/renuo/renuo-upload-ruby) [![Build Status](https://travis-ci.org/renuo/renuo-upload-ruby.svg?branch=develop)](https://travis-ci.org/renuo/renuo-upload-ruby)
+
+# Renuo Upload
+
+Gem for Ruby 2.0+ applications that use the excellent Renuo Upload
+
+## Installation
+
+Add this line to your application's Gemfile and run bundle:
+
+```ruby
+gem 'renuo-upload'
+```
+
+## Usage
+
+### Configuration
+
+The configuration is optional. If you want to use it, add an initializer:
+
+```ruby
+RenuoUpload.configure do |config|
+  config.api_key = 'custom-api-key'             # Default: ENV['RENUO_UPLOAD_API_KEY']
+  config.signing_url = 'custom-signing-url'     # Default: ENV['RENUO_UPLOAD_SIGNING_URL']
+end
+```
+
+### Example
+
+```ruby
+require 'renuo-upload'
+
+file = File.new('tmp/examplefile.pdf')
+file_url = RenuoUpload.upload!(file)
+```
+
+## Development
+
+### Contributing
+
+See the [CONTRIBUTING](CONTRIBUTING.md) file.
+
+### Release
+
+```sh
+git flow release start [.....]
+# adjust version.rb
+# check (and adjust) CHANGELOG.md
+bundle install
+git commit -av
+git flow release finish [.....]
+git push origin develop:develop
+git push origin master:master
+git checkout master
+bundle exec rake release
+git checkout develop
+```
+
+## Copyright
+
+Renuo GmbH (https://www.renuo.ch) - [MIT LICENSE](LICENSE) - 2016

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task(:check) { sh('bin/check') }
+task(:setup) { sh('bin/setup') }
+task default: :check

data/lib/renuo-upload.rb

@@ -0,0 +1,4 @@
+require 'rest_client'
+require 'renuo_upload/version'
+require 'renuo_upload/config'
+require 'renuo_upload/uploader'

data/lib/renuo_upload/config.rb

@@ -0,0 +1,26 @@
+module RenuoUpload
+  class << self
+    attr_writer :config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.reset
+    @config = Config.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class Config
+    attr_accessor :api_key, :signing_url
+
+    def initialize
+      self.api_key = ENV['RENUO_UPLOAD_API_KEY']
+      self.signing_url = ENV['RENUO_UPLOAD_SIGNING_URL']
+    end
+  end
+end

data/lib/renuo_upload/uploader.rb

@@ -0,0 +1,40 @@
+module RenuoUpload
+  def self.upload!(file)
+    Uploader.new(RenuoUpload.config).upload(file)
+  end
+
+  class Uploader
+    def initialize(config)
+      @config = config
+      @policy = retrieve_policy
+    end
+
+    def upload(file)
+      RestClient.post upload_url, upload_hash(file)
+      uploaded_file_url file
+    end
+
+    private
+
+    def retrieve_policy
+      response = RestClient.post @config.signing_url, api_key: @config.api_key
+      JSON.parse response.body
+    end
+
+    def upload_url
+      @policy['url']
+    end
+
+    def upload_data
+      @policy['data']
+    end
+
+    def upload_hash(file)
+      Hash[upload_data.map { |key, value| [key.tr('_', '-'), value] }].merge file: file
+    end
+
+    def uploaded_file_url(file)
+      @policy['file_url_path'].concat File.basename(file)
+    end
+  end
+end

data/lib/renuo_upload/version.rb

@@ -0,0 +1,3 @@
+module RenuoUpload
+  VERSION = '0.0.1'.freeze
+end

data/renuo_upload.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'renuo_upload/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'renuo-upload'
+  spec.version = RenuoUpload::VERSION
+  spec.authors = ['Cyril Kyburz', 'Alessandro Rodi', 'Lukas Elmer']
+  spec.email = ['cyril.kyburz@renuo.ch', 'alessandro.rodi@renuo.ch', 'lukas.elmer@renuo.ch']
+
+  spec.summary = 'Ruby client for renuo upload'
+  spec.description = 'The renuo upload allows in compination with the renuo upload service to easily upload files.'
+  spec.homepage = 'https://github.com/renuo/renuo-upload-ruby'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.add_dependency 'rest-client', '>= 1.8.0'
+
+  spec.add_development_dependency 'rspec', '>= 3.4.0'
+  spec.add_development_dependency 'rubocop', '>= 0.40.0'
+  spec.add_development_dependency 'reek', '>= 4.0.4'
+  spec.add_development_dependency 'climate_control', '>= 0.0.3'
+  spec.add_development_dependency 'pry', '>= 0.10.3'
+  spec.add_development_dependency 'webmock', '>= 2.1.0'
+end

data/spec/data/file.txt

@@ -0,0 +1 @@
+Example file

data/spec/data/policy.json

@@ -0,0 +1,16 @@
+{
+  "url": "https://bucket.s3.eu-central-1.amazonaws.com/",
+  "data": {
+    "key": "o/application/1xyj/db9f/aac4/3a98/2d85/e016/aa7d/700f/7ed0/${filename}",
+    "acl": "public-read",
+    "policy": "6vEpDAg21V0f6tI00RRgffblpKMNJRnJj856DgD1udZp93Oj7a2HehpUseUIf8VlXCoJrdtSSi/23oK0qLJOuMVGjgfONLZPX4PFv79ILwKmQViCG6FJZNw8Hj7NdGS9955kd+pB5Z75LiPG8dBBDl0ByOvPSdqjmoUNbZ7fsoFwwNBORl8P1G2bUspLPKfHNmfNKapScwoFuyEDH8h3j+emu2iiwQ+uPD/vr1nCofrtFbhYKcOyVlfTp3501UknokidZY7FlhqggJJG72eNLmJ5WEHec7FaqSE/AtpK07fSwCVkWOYO+Y4KryKg4IcwgT3kOVWDmgLk7dHsF4ySmTQvCkRbt9hI7oOv1pN0lm1qwxPQFLWXEk/2hBbd8j4abKP+za+1TjTuS6FN7i/m/TH26eKTLKInV+/4I0sBORHGOtRmelmo393ubSUHOpsntUeRm9/58gC2SLpQUiEE1nKpN0Qwz7ypfWg8Y4xHfs9WFzOXX09xpRPuGNsA+PergflqKxwkBt8oeFB/URmNBKdXO9R90ueirMuz5O8yFhuk==",
+    "x_amz_algorithm": "AWS4-HMAC-SHA256",
+    "x_amz_credential": "AKIAJP5UELFNK1QE4FAD/20160615/eu-central-1/s3/aws4_request",
+    "x_amz_expires": 28800,
+    "x_amz_signature": "04d5f8b52b6e0a7a83ffb77655ab10ab7377dd60ce949b50fce189a2d7078d90",
+    "x_amz_date": "20160615T123654Z",
+    "utf8": "✓"
+  },
+  "file_prefix": "1xyj/db9f/aac4/3a98/2d85/e016/aa7d/700f/7ed0/",
+  "file_url_path": "//cdn.renuoapp.ch/o/application/1xyj/db9f/aac4/3a98/2d85/e016/aa7d/700f/7ed0/"
+}

data/spec/renuo_upload/config_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+RSpec.describe RenuoUpload do
+  let(:config) { RenuoUpload::Config.new }
+
+  describe RenuoUpload::Config do
+    [
+      [:RENUO_UPLOAD_API_KEY, :api_key, 'custom-api-key', 'new-key'],
+      [:RENUO_UPLOAD_SIGNING_URL, :signing_url, 'custom-signing-url', 'new-su']
+    ].each do |env_variable_name, method, default_value, new_value|
+      describe "##{method}" do
+        it 'is the default value from the ENV variable' do
+          ClimateControl.modify env_variable_name => default_value do
+            expect(config.send(method)).to eq(default_value)
+          end
+        end
+      end
+
+      describe "##{method}=" do
+        it 'can set value without an env variable' do
+          config.send("#{method}=", new_value)
+          expect(config.send(method)).to eq(new_value)
+        end
+
+        it 'can set value when an env variable is defined' do
+          ClimateControl.modify env_variable_name => default_value do
+            config.send("#{method}=", new_value)
+            expect(config.send(method)).to eq(new_value)
+          end
+        end
+      end
+
+      describe "#reset (#{method})" do
+        it "resets the #{method}" do
+          ClimateControl.modify env_variable_name => default_value do
+            RenuoUpload.configure { |config| config.send("#{method}=", new_value) }
+            expect { RenuoUpload.reset }.to change { RenuoUpload.config.send(method) }.from(new_value).to(default_value)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/renuo_upload/uploader_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+RSpec.describe RenuoUpload do
+  let(:file) { load_file('file.txt') }
+
+  def load_file(name)
+    File.new(File.expand_path("../../data/#{name}", __FILE__))
+  end
+
+  describe '#upload' do
+    let(:fake_uploader) { Struct.new(:upload).new }
+    let(:file_url) { 'https://file.url' }
+
+    it 'can upload a file' do
+      expect(RenuoUpload::Uploader).to receive(:new).with(RenuoUpload.config).and_return(fake_uploader)
+      expect(fake_uploader).to receive(:upload).with(file).and_return(file_url)
+      expect(described_class.upload!(file)).to eq file_url
+    end
+  end
+
+  describe RenuoUpload::Uploader do
+    let(:uploader) { described_class.new(config) }
+    let(:config) { RenuoUpload.config }
+    let(:policy) { JSON.parse(load_file('policy.json').read) }
+
+    before do
+      config.api_key = 'api-key'
+      config.signing_url = 'signing-url'
+      stub_request(:post, config.signing_url).to_return(body: load_file('policy.json'))
+    end
+
+    describe '#new' do
+      it 'can be initialized with the renuo upload config' do
+        expect(uploader.instance_variable_get(:@policy)).to eq policy
+        expect(uploader.instance_variable_get(:@config)).to be RenuoUpload.config
+      end
+    end
+
+    describe '#upload' do
+      let(:file_url) { '//cdn.renuoapp.ch/o/application/1xyj/db9f/aac4/3a98/2d85/e016/aa7d/700f/7ed0/file.txt' }
+
+      it 'upload the file to the provided server by the policy' do
+        stub = stub_request(:post, policy['url']).with(headers: { 'Content-Length' => '1512' })
+
+        expect(uploader.upload(file)).to eq file_url
+
+        expect(stub).to have_been_requested
+      end
+    end
+
+    describe '#retrieve_policy' do
+      it 'requests the policy from the renuo upload service' do
+        expect(uploader.send(:retrieve_policy).values_at('url', 'data')).to_not include(nil)
+      end
+    end
+
+    describe '#upload_hash' do
+      it 'removes underscores and replace them with dashes, just for the keys' do
+        expect(uploader).to receive(:upload_data).and_return('key_key_key' => 'value')
+        uploaded_hash = uploader.send(:upload_hash, 'dummy_file')
+        expect(uploaded_hash['key-key-key']).to eq 'value'
+        expect(uploaded_hash[:file]).to eq 'dummy_file'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'renuo-upload'
+require 'climate_control'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: renuo-upload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cyril Kyburz
+- Alessandro Rodi
+- Lukas Elmer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: The renuo upload allows in compination with the renuo upload service
+  to easily upload files.
+email:
+- cyril.kyburz@renuo.ch
+- alessandro.rodi@renuo.ch
+- lukas.elmer@renuo.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/renuo-upload.rb
+- lib/renuo_upload/config.rb
+- lib/renuo_upload/uploader.rb
+- lib/renuo_upload/version.rb
+- renuo_upload.gemspec
+- spec/data/file.txt
+- spec/data/policy.json
+- spec/renuo_upload/config_spec.rb
+- spec/renuo_upload/uploader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/renuo/renuo-upload-ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for renuo upload
+test_files:
+- spec/data/file.txt
+- spec/data/policy.json
+- spec/renuo_upload/config_spec.rb
+- spec/renuo_upload/uploader_spec.rb
+- spec/spec_helper.rb