paperclip-webmerge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8f6abbc6698c4131b6557f6c22006be00ca0713
+  data.tar.gz: 4cb92d7fd9605cf7271d07143100e9d141191870
+SHA512:
+  metadata.gz: f04e61dd84e9218a6eb0723aa910266bd1dfde5ac6c80f9bd735095d2795806f600d9ef3518e2785a52ce56325588a1eb0874f04324e8aa96c364b692181ff10
+  data.tar.gz: ce14e3963b14fd479d1e9b932427be2e5850b5f8d0cab29588e73686a862aee79baaf5bd7014fde9bce250ceed39f027315e1bc35d2b83150fd5d0b758970855

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'web_merge', github: 'radicalbear/api-ruby'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joshua Plicque
+
+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,112 @@
+# Paperclip WebMerge
+
+This gem allows you to save [Paperclip](https://github.com/thoughtbot/paperclip) files on [WebMerge](https://www.webmerge.me/)
+
+
+## Installation
+
+Add this line to your application's Gemfile. Bundle, then restart your server.
+
+```ruby
+gem 'paperclip-webmerge'
+```
+Migrate your model to have a `web_merge_id` integer attribute. When Paperclip saves your file, it will reference the document id on WebMerge with this attribute.
+
+```
+rails g migration add_web_merge_id_to_your_model web_merge_id:integer
+rake db:migrate
+```
+
+
+## Setup
+
+Example:
+
+Add paperclip to your model, specifiying `:web_merge` as the storage adapter.
+
+```ruby
+class User
+  has_attached_file :document, storage: :web_merge, web_merge_credentials: Rails.root.join('config/web_merge.yml')
+  ...
+end
+```
+Add WebMerge your API credentials. You can get your credentials under "Api Access" over at [WebMerge](https://www.webmerge.me/)
+
+```
+# config/web_merge.yml
+
+api_key: <%= ENV["WEB_MERGE_API_KEY"] %>,
+api_secret: <%= ENV["WEB_MERGE_API_SECRET"] %>
+```
+
+You are fully setup. Your files now sync up with WebMerge!
+
+
+## Usage
+
+### The `:web_merge_credentials` option
+
+```ruby
+:web_merge_credentials => Rails.root.join("config/web_merge.yml")
+# or
+:web_merge_credentials => {api_key: "foo", api_secret: "bar"}
+```
+
+For the list of required credentials, take a look at the `config/web_merge.yml`
+above.
+
+The YAML file supports ERB:
+
+```
+api_key: <%= ENV["WEB_MERGE_API_KEY"] %>
+api_secret: <%= ENV["WEB_MERGE_API_SECRET"] %>
+```
+
+And it supports environment nesting (just like `database.yml`):
+
+```yaml
+development:
+  api_key: "..."
+  api_secret: "..."
+production:
+  api_key: "..."
+  api_secret: "..."
+```
+
+### The `:path` option
+
+To change the path of the file, use Paperclip's `:path` option:
+
+```ruby
+:path => ":style/:id_:filename"  # Defaults to ":filename"
+```
+
+### URL options
+
+If you want to force the browser to always download the file, you can use
+the `:download` option.
+
+```ruby
+user.document.url(:download => true)
+```
+
+### Check if the file exists
+
+It may happen that a file on WebMerge gets deleted remotely. To check this in
+your application, you can use the `#exists?` method:
+
+```ruby
+user.document.exists?
+# user.document.exists?(style)
+```
+
+## Contributing
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/plicjo/paperclip-webmerge.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/paperclip_web_merge.rb

@@ -0,0 +1,102 @@
+require 'paperclip_web_merge/version'
+require 'web_merge'
+
+module Paperclip
+  module Storage
+    module WebMerge
+      def self.extended base
+        begin
+          require 'web_merge'
+        rescue LoadError => e
+          e.message << " (You may need to install the web_merge gem)"
+          raise e
+        end
+
+        base.instance_eval do
+          @web_merge_credentials = parse_credentials(@options[:web_merge_credentials])
+          @client = ::WebMerge::API.new(secret: @web_merge_credentials[:api_secret], key: @web_merge_credentials[:api_key])
+        end
+      end
+
+      def parse_credentials creds
+        creds = find_credentials(creds).stringify_keys
+        creds.symbolize_keys
+      end
+
+      def exists?(style = default_style)
+        if original_filename
+          begin
+            ::WebMerge::Document.find(instance.web_merge_id, client: @client)
+          rescue
+            false
+          end
+        else
+          false
+        end
+      end
+
+      def copy_to_local_file(style, local_dest_path)
+        log("copying #{path(style)} to local file #{local_dest_path}")
+        ::File.open(local_dest_path, 'wb') do |local_file|
+          file_contents = @client.get_document_file(instance.web_merge_id)['contents']
+          web_merge_file = Base64.decode64(file_contents)
+          local_file.write(web_merge_file)
+        end
+      rescue
+        warn("cannot copy #{path(style)} to local file #{local_dest_path}")
+        false
+      end
+
+      def file_type(file)
+        {
+          'application/vnd.openxmlformats-officedocument.wordprocessingml.document'   => 'docx',
+          'application/pdf'                                                           => 'pdf',
+          'application/vnd.ms-excel'                                                  => 'xlsx',
+          'application/vnd.ms-excel.sheet.macroenabled.12'                            => 'xlsx',
+          'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'         => 'xlsx',
+          'application/vnd.openxmlformats-officedocument.presentationml.presentation' => 'pptx',
+          'application/vnd.ms-powerpoint'                                             => 'pptx',
+          'application/zip'                                                           => -> { MIME::Types.type_for(file.path).first.to_s },
+          'application/octet-stream'                                                  => -> { MIME::Types.type_for(file.path).first.to_s }
+        }[file.content_type]
+      end
+
+      def flush_writes
+        @queued_for_write.each do |style, file|
+          log("Saving to WebMerge #{path(style)}")
+          document = ::WebMerge::Document.new(client: @client, name: path, type: file_type(file), output: file_type(file), file_path: file.path)
+          document.save!
+          instance.update_column(:web_merge_id, document.id)
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            @client.delete_document(instance.web_merge_id)
+            instance.update_column(:web_merge_id, nil)
+          rescue
+            log("error deleting #{path}")
+          end
+        end
+        @queued_for_delete = []
+      end
+
+      def find_credentials creds
+        case creds
+        when File
+          YAML::load(ERB.new(File.read(creds.path)).result)
+        when String
+          YAML::load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          raise ArgumentError, "Credentials are not a path, file, or hash."
+        end
+      end
+      private :find_credentials
+    end
+  end
+end

data/lib/paperclip_web_merge/version.rb

@@ -0,0 +1,7 @@
+module Paperclip
+  module Storage
+    module WebMerge
+      VERSION = '0.0.1'
+    end
+  end
+end

data/paperclip-webmerge.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip_web_merge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-webmerge"
+  spec.version       = Paperclip::Storage::WebMerge::VERSION
+  spec.authors       = ["Joshua Plicque"]
+  spec.email         = ["plicjo@gmail.com"]
+
+  spec.summary       = %q{A Paperclip storage adapter for WebMerge}
+  spec.description   = %q{A Paperclip storage adapter for WebMerge}
+  spec.homepage      = "http://github.com/plicjo/paperclip-web-merge"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-webmerge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Plicque
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Paperclip storage adapter for WebMerge
+email:
+- plicjo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperclip_web_merge.rb
+- lib/paperclip_web_merge/version.rb
+- paperclip-webmerge.gemspec
+homepage: http://github.com/plicjo/paperclip-web-merge
+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: A Paperclip storage adapter for WebMerge
+test_files: []