attache-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8931e55f0ecea4268085000b50136ef7b10fd0ac
+  data.tar.gz: d4aa35b5cfb27dab0c89cfbdcef04863a0e8d853
+SHA512:
+  metadata.gz: 9fd0d41f14b5dd23285b5b2e4e8ae05f16ce614f7cc581c6dc1a1d88130dc8c1972505e3899fb22e67f88fb34a22ab303b59a306eb99a3dc8c35f41bcb6a6c72
+  data.tar.gz: 1971d934bffa4ad420271b82a75a14ffe404514a759e9fb5c7a762737260f98fac24ecbd8819fcf53b139bcc1d4c6ac95643c751cb3ac7451e4d3884f1d81c8a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 choonkeat
+
+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,33 @@
+# Attache/API
+
+[![Build Status](https://travis-ci.org/choonkeat/attache-api.svg?branch=master)](https://travis-ci.org/choonkeat/attache-api)
+
+Core library and tests to integrate with an [attache](https://github.com/choonkeat/attache) server; to be leveraged by client libraries e.g. [attache_rails](https://github.com/choonkeat/attache_rails) which integrates with ActiveRecord
+
+## Testing against an attache-compatible server
+
+Test suite will interact with a server when `ATTACHE_URL` is explicitly set. This can conveniently check if a server at a given URL is attache-compatible. To run such compatibility check, execute the test suite with `ATTACHE_URL` and `ATTACHE_SECRET_KEY` set to the correct values
+
+```
+ATTACHE_URL=http://localhost:9292 ATTACHE_SECRET_KEY=topsecret rake
+```
+
+NOTE: the test suite will upload a small jpg file and delete it immediately, for several iterations.
+
+## Environment variables
+
+Important variables:
+
+- `ATTACHE_URL` url pointing to the attache server instance, default `http://localhost:9292`
+- `ATTACHE_SECRET_KEY` optional shared secret with attache server, default no secret
+
+Optional variables:
+
+- `ATTACHE_UPLOAD_DURATION` browser upload signature expiration duration, default 3 hours; used in conjunction with `ATTACHE_SECRET_KEY`
+- `ATTACHE_UPLOAD_URL`, `ATTACHE_DOWNLOAD_URL`, `ATTACHE_DELETE_URL` specific urls pointing to upload, download, delete API end points, default `{ATTACHE_URL}/upload`, `{ATTACHE_URL}/view`, `{ATTACHE_URL}/delete`
+- `ATTACHE_DISCARD_FAILURE_RAISE_ERROR` when set, raises an error if deleting of files causes an error. by default, deletion errors are discarded
+
+## License
+
+MIT
+

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/lib/attache/api.rb

@@ -0,0 +1,4 @@
+require 'attache/api/version'
+require 'attache/api/utils'
+require 'attache/api/v1'
+require 'attache/api/model'

data/lib/attache/api/model.rb

@@ -0,0 +1,43 @@
+module Attache
+  module API
+    module Model
+      def attache_field_options(attr_value, geometry, options = {})
+        V1.attache_options(geometry, attache_field_attributes(attr_value, geometry), options)
+      end
+
+      def attache_field_urls(attr_value, geometry)
+        attache_field_attributes(attr_value, geometry).collect {|attrs| attrs['url']}
+      end
+
+      def attache_field_attributes(attr_value, geometry)
+        Utils.array(attr_value).inject([]) do |sum, obj|
+          sum + Utils.array(obj && obj.tap {|attrs|
+            attrs['url'] = V1.attache_url_for(attrs['path'], geometry)
+          })
+        end
+      end
+
+      def attache_field_set(array)
+        new_value = Utils.array(array).inject([]) {|sum,value|
+          hash = value.respond_to?(:read) && V1.attache_upload(value) || value
+          hash = JSON.parse(hash.to_s) rescue Hash(error: $!) unless hash.kind_of?(Hash)
+          okay = hash.respond_to?(:[]) && (hash['path'] || hash[:path])
+          okay ? sum + [hash] : sum
+        }
+        Utils.array(new_value)
+      end
+
+      def attache_mark_for_discarding(old_value, new_value, attaches_discarded)
+        obsoleted = Utils.array(old_value).collect {|x| x['path'] } - Utils.array(new_value).collect {|x| x['path'] }
+        obsoleted.each {|path| attaches_discarded.push(path) unless path.nil? || path == "" }
+      end
+
+      def attaches_discard!(files)
+        files.reject! {|x| x.nil? || x == "" }
+        V1.attache_delete(*files.uniq) unless files.empty?
+      rescue Exception
+        raise if ENV['ATTACHE_DISCARD_FAILURE_RAISE_ERROR']
+      end
+    end
+  end
+end

data/lib/attache/api/test.rb

@@ -0,0 +1,13 @@
+require "attache/api/v1"
+
+Attache::API::V1::HTTPClient.class_eval do
+  def post(*args)
+    Struct.new(:body).new.tap do |response|
+      response.body = '{}' # empty json
+    end
+  end
+
+  def post_content(*args)
+    ""
+  end
+end

data/lib/attache/api/utils.rb

@@ -0,0 +1,16 @@
+module Attache
+  module API
+    module Utils
+      class << self
+        def array(value)
+          case value
+          when Array
+            value
+          else
+            [value]
+          end.reject {|x| x.nil? || x == "" }
+        end
+      end
+    end
+  end
+end

data/lib/attache/api/v1.rb

@@ -0,0 +1,81 @@
+require 'securerandom'
+require "httpclient"
+require 'openssl'
+require 'uri'
+require 'cgi'
+
+module Attache
+  module API
+    module V1
+      class HTTPClient < ::HTTPClient; end # local reference
+
+      ATTACHE_URL             = ENV.fetch('ATTACHE_URL')             { "http://localhost:9292" }
+      ATTACHE_UPLOAD_URL      = ENV.fetch('ATTACHE_UPLOAD_URL')      { "#{ATTACHE_URL}/upload" }
+      ATTACHE_DOWNLOAD_URL    = ENV.fetch('ATTACHE_DOWNLOAD_URL')    { "#{ATTACHE_URL}/view" }
+      ATTACHE_DELETE_URL      = ENV.fetch('ATTACHE_DELETE_URL')      { "#{ATTACHE_URL}/delete" }
+      ATTACHE_UPLOAD_DURATION = ENV.fetch('ATTACHE_UPLOAD_DURATION') { 3*3600 }.to_i # expires signed upload form
+      ATTACHE_SECRET_KEY      = ENV['ATTACHE_SECRET_KEY']            # unset to test password-less interaction
+
+      def attache_upload(readable)
+        uri = URI.parse(ATTACHE_UPLOAD_URL)
+        original_filename =
+          readable.respond_to?(:original_filename) && readable.original_filename ||
+          readable.respond_to?(:path) && File.basename(readable.path) ||
+          'noname'
+        uri.query = { file: original_filename, **attache_auth_options }.collect {|k,v|
+          CGI.escape(k.to_s) + "=" + CGI.escape(v.to_s)
+        }.join('&')
+        res = attache_retry_doing(3) { HTTPClient.post(uri, readable, {'Content-Type' => 'binary/octet-stream'}) }
+        res.body
+      end
+
+      def attache_url_for(path, geometry)
+        prefix, basename = File.split(path)
+        [ATTACHE_DOWNLOAD_URL, prefix, CGI.escape(geometry), CGI.escape(basename)].join('/')
+      end
+
+      def attache_delete(*paths)
+        HTTPClient.post_content(
+          URI.parse(ATTACHE_DELETE_URL),
+          attache_auth_options.merge(paths: paths.join("\n"))
+        )
+      end
+
+      def attache_auth_options
+        if ATTACHE_SECRET_KEY
+          uuid = SecureRandom.uuid
+          expiration = (Time.now + ATTACHE_UPLOAD_DURATION).to_i
+          hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ATTACHE_SECRET_KEY, "#{uuid}#{expiration}")
+          { uuid: uuid, expiration: expiration, hmac: hmac }
+        else
+          {}
+        end
+      end
+
+      def attache_options(geometry, current_value, auth_options: true, placeholder: nil, data: {})
+        {
+          data: {
+            geometry: geometry,
+            value: [*current_value],
+            placeholder: [*placeholder],
+            uploadurl: ATTACHE_UPLOAD_URL,
+            downloadurl: ATTACHE_DOWNLOAD_URL,
+          }.merge(data || {}).merge(auth_options == false ? {} : attache_auth_options),
+        }
+      end
+
+      def attache_retry_doing(max_retries, retries = 0, exception_class = Exception)
+        yield
+      rescue exception_class
+        if (retries += 1) <= max_retries
+          max_sleep_seconds = Float(2 ** retries)
+          sleep rand(0..max_sleep_seconds)
+          retry
+        end
+        raise
+      end
+
+      self.extend(self)
+    end
+  end
+end

data/lib/attache/api/version.rb

@@ -0,0 +1,5 @@
+module Attache
+  module API
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: attache-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- choonkeat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  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: 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: fastimage
+  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: minitest
+  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: guard
+  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: guard-minitest
+  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:
+- choonkeat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/attache/api.rb
+- lib/attache/api/model.rb
+- lib/attache/api/test.rb
+- lib/attache/api/utils.rb
+- lib/attache/api/v1.rb
+- lib/attache/api/version.rb
+homepage: https://github.com/choonkeat/attache-api
+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.8
+signing_key: 
+specification_version: 4
+summary: API for client lib to integrate with attache server
+test_files: []