carrierwave-truevault 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a52a2c2dc21a9cb6cd5f430e7d8ea9b9e45060c
+  data.tar.gz: dd3b9b48f9588cc2f96f08c7a7eafba0b34fa7a6
+SHA512:
+  metadata.gz: dd8658d7423a56697cf65650401f3045a708e0eb433f966253fb6a212cbabad30c73085f74c3e3d16383562b7cd59d43ab66e7d5f03c6bd829f89ca9e159a119
+  data.tar.gz: 76201253390d18e204f7b35c477d9fa3d598ee98ade47491aef05f6632151a95c0bf408867337c610b8e589b85cf820574fe2231ebb971bfcf6238d9f6684456

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 carrierwave-truevault.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew McFarling
+
+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,46 @@
+# Carrierwave::TrueVault
+
+This gem adds support for [TrueVault](https://truevault.com) to the CarrierWave.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carrierwave-truevault'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierwave-truevault
+
+## Usage
+
+You'll need to add a configuration block in your ```
+config/initializers/carrierwave.rb ``` file.
+
+```ruby
+CarrierWave.configure do |config|
+  config.truevault_api_key = "xxxxxx......"
+  config.truevault_vault_id = "xxxxx......"
+  config.truevault_attributes = {}
+end
+```
+
+In your uploader add truevault as the storage option:
+
+```ruby
+class DocumentUploader < CarrierWave::Uploader::Base
+  storage :truevault
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/carrierwave-truevault/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/carrierwave-truevault.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/truevault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-truevault"
+  spec.version       = Carrierwave::TrueVault::VERSION
+  spec.authors       = ["Matthew McFarling"]
+  spec.email         = ["matt@codemancode.com"]
+  spec.summary       = %q{TrueVault integration for Carrierwave.}
+  spec.description   = %q{Carrierwave storage for TrueVault.}
+  spec.homepage      = "http://www.codemancode.com"
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "carrierwave"
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/carrierwave/storage/truevault.rb

@@ -0,0 +1,121 @@
+require 'pathname'
+
+module CarrierWave
+  module Storage
+    class TrueVault < Abstract
+      def store!(file)
+        f = CarrierWave::Storage::TrueVault::File.new(uploader, self, uploader.store_path)
+        f.store(file)
+        f
+      end
+
+      def retrieve!(identifier)
+        f = CarrierWave::Storage::TrueVault::File.new(uploader, self, uploader.store_path(identifier))
+        f.retrieve(identifier)
+        f
+      end
+
+      class File
+        include CarrierWave::Utilities::Uri
+        attr_reader :path
+
+        def filename
+          Pathname.new(path).basename
+        end
+        ##
+        # Lookup value for file content-type header
+        #
+        # === Returns
+        #
+        # [String] value of content-type
+        #
+        def content_type
+          @content_type || file.content_type
+        end
+
+        ##
+        # Set non-default content-type header (default is file.content_type)
+        #
+        # === Returns
+        #
+        # [String] returns new content type value
+        #
+        def content_type=(new_content_type)
+          @content_type = new_content_type
+        end
+
+        def initialize(uploader, base, path)
+          @uploader, @base, @path = uploader, base, path
+        end
+
+        ##
+        # Read content of file from service
+        #
+        # === Returns
+        #
+        # [String] contents of file
+        def read
+          file
+        end
+
+        ##
+        # Return size of file body
+        #
+        # === Returns
+        #
+        # [Integer] size of file body
+        #
+        def size
+          file.content_length
+        end
+
+        def truevault_attributes
+          attributes
+        end
+
+        ##
+        # Write file to service
+        #
+        # === Returns
+        #
+        # [Boolean] true on success or raises error
+        #
+        def store(file)
+          truevault_file = file.to_file
+          @content_type ||= file.content_type
+          @file = client.create_blob(@uploader.truevault_vault_id, truevault_file)
+          @uploader.truevault_attributes.merge!(@file.parsed_response)
+        end
+
+        ##
+        # Retrieve file from service
+        #
+        # === Returns
+        #
+        # [File]
+        #
+        def retrieve(identifier)
+          @file = client.get_blob(@uploader.truevault_vault_id, model.blob_id)
+          @file ||= @file.parsed_response
+        end
+
+        private
+
+        def model
+          @uploader.model
+        end
+
+        def client
+          CarrierWave::TrueVault::Client.new(@uploader.truevault_api_key)
+        end
+
+        def file
+          tmp = client.get_blob(@uploader.truevault_vault_id, model.blob_id)
+          @file ||= IO.binread(tmp.parsed_response)
+          @file
+        end
+
+      end
+    end
+  end
+end

data/lib/carrierwave/truevault/client.rb

@@ -0,0 +1,121 @@
+# Code extracted from https://github.com/marks/truevault.rb
+require 'httparty'
+
+module CarrierWave
+  module TrueVault
+    # Custom parser class for TrueVault API
+    class Parser < HTTParty::Parser
+      SupportedFormats.merge!({"application/octet-stream" => :octet_stream})
+
+      def parse
+        case format
+          when :html
+            body
+          when :json
+            JSON.parse(body)
+          when :octet_stream
+            # TODO find a better way of doing this
+            # The issue is that no matter what it gets frmo TV
+            # the ContentType is always octet_stream
+            begin
+              JSON.parse(Base64.decode64(body))
+            rescue JSON::ParserError
+              file = Tempfile.new('blob')
+              file.binmode
+              file.write(body)
+              file.rewind
+              file
+            end
+          else
+            body
+        end
+      end
+
+    end
+
+    class Client
+      include HTTParty
+      require 'json'
+      require 'base64'
+
+      # debug_output
+      base_uri 'https://api.truevault.com'
+      parser Parser
+
+      def default_options_to_merge_with
+        {:basic_auth => {:username => @api_key, :password => nil}}
+      end
+
+      def hash_to_base64_json(hash = {})
+        Base64.encode64(hash.to_json)
+      end
+
+      # api_key         should be a valid TrueVault API key
+      # account_id      should be a valid TrueVault account ID
+      # api_version     should be a valid API version (ex 'v1')
+      def initialize(api_key, api_version = 'v1')
+        @api_key = api_key
+        @api_ver = api_version
+        instance_variables.each do |variable|
+          raise ArgumentError, "#{variable} should not be nil or blank" if instance_variable_get(variable.to_sym).to_s == ""
+        end
+      end
+
+      ####################################################
+      ### JSON (structured text data store) API Methods
+      ####################################################
+
+      # vault_id        should be a valid vault ID
+      # document_id     should be a valid document ID
+      # document_data   should be a Ruby Hash. Method will convert it to JSON and base64 encode as required
+      def create_document(vault_id, document_data, options = {})
+        options.merge!(default_options_to_merge_with)
+        options[:body] = {:document => hash_to_base64_json(document_data)}
+        self.class.post("/#{@api_ver}/vaults/#{vault_id}/documents", options)
+      end
+
+      def get_document(vault_id, document_id, options = {})
+        options.merge!(default_options_to_merge_with)
+        self.class.get("/#{@api_ver}/vaults/#{vault_id}/documents/#{document_id}", options)
+      end
+
+      def delete_document(vault_id, document_id, options = {})
+        options.merge!(default_options_to_merge_with)
+        self.class.delete("/#{@api_ver}/vaults/#{vault_id}/documents/#{document_id}", options)
+      end
+
+      def update_document(vault_id, document_id, document_data, options = {})
+        options.merge!(default_options_to_merge_with)
+        options[:body] = {:document => hash_to_base64_json(document_data)}
+        self.class.put("/#{@api_ver}/vaults/#{vault_id}/documents/#{document_id}", options)
+      end
+
+      #####################################
+      ### BLOB (binary file) API Methods
+      #####################################
+
+      def create_blob(vault_id, file, options = {:headers => {"Content-Type"=>"application/octet-stream"}})
+        options.merge!(default_options_to_merge_with)
+        options[:body] = file.read
+        self.class.post("/#{@api_ver}/vaults/#{vault_id}/blobs", options)
+      end
+
+      def replace_blob(vault_id, blob_id, file, options = {:headers => {"Content-Type"=>"application/octet-stream"}})
+        options.merge!(default_options_to_merge_with)
+        options[:body] = file.read
+        self.class.put("/#{@api_ver}/vaults/#{vault_id}/blobs/#{blob_id}", options)
+      end
+
+      def delete_blob(vault_id, blob_id, options = {})
+        options.merge!(default_options_to_merge_with)
+        self.class.delete("/#{@api_ver}/vaults/#{vault_id}/blobs/#{blob_id}", options)
+      end
+
+      def get_blob(vault_id, blob_id, options = {})
+        options.merge!(default_options_to_merge_with)
+        self.class.get("/#{@api_ver}/vaults/#{vault_id}/blobs/#{blob_id}", options)
+      end
+
+    end
+  end
+end

data/lib/carrierwave/truevault/version.rb

@@ -0,0 +1,5 @@
+module Carrierwave
+  module TrueVault
+    VERSION = "0.0.1"
+  end
+end

data/lib/carrierwave/truevault.rb

@@ -0,0 +1,14 @@
+require 'carrierwave'
+require 'carrierwave/truevault/client'
+require 'carrierwave/storage/truevault'
+require "carrierwave/truevault/version"
+
+class CarrierWave::Uploader::Base
+  add_config :truevault_api_key
+  add_config :truevault_vault_id
+  add_config :truevault_attributes
+
+  configure do |config|
+    config.storage_engines[:truevault] = 'CarrierWave::Storage::TrueVault'
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-truevault
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew McFarling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  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: httparty
+  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'
+description: Carrierwave storage for TrueVault.
+email:
+- matt@codemancode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carrierwave-truevault.gemspec
+- lib/carrierwave/storage/truevault.rb
+- lib/carrierwave/truevault.rb
+- lib/carrierwave/truevault/client.rb
+- lib/carrierwave/truevault/version.rb
+homepage: http://www.codemancode.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: TrueVault integration for Carrierwave.
+test_files: []