jackal-assets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 442d2cbf6b9fd0b6efa1123a1331a87d42814180
+  data.tar.gz: 3cd7bb3f70a8b8ff56cd1576d1f327353a41ddd7
+SHA512:
+  metadata.gz: 6a5a1521f5a4be2df8b8953982fac97188fb137b6451dd94d605b47af47e694b9ea39b024be32e6f878c3ea6b671cc62753b0bcea69f5f6ba68ce7d780231529
+  data.tar.gz: 2ab1b4eacc496ba34bf3f93d74d86880088f47760112126d7ce8b9ed8777e03ade358b650f61e08b722b322427a5fa58987f6787ff21d5a388f2f0ef753df193

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.1.0
+* Initial release

data/README.md

@@ -0,0 +1,40 @@
+# Jackal Assets
+
+Simple API to store and retrieve objects.
+
+## Usage
+
+```ruby
+
+require 'jackal-assets'
+
+object_store = Jackal::Assets::Store.new
+object = object_store.get('item/i/want.json')
+
+File.open('/tmp/fubar', 'w') do |f|
+  f.write object.readpartial
+  f.puts 'YAY'
+end
+
+object_store.put('my/updated/file.json', '/tmp/fubar')
+```
+
+## Configuration
+
+Configure
+
+```json
+{
+  "jackal": {
+    "assets": {
+      "provider": "aws",
+      "credentials": {
+      },
+      "bucket": "BUCKET_NAME"
+    }
+  }
+}
+```
+
+# Info
+* Repository: https://github.com/carnivore-rb/jackal-assets

data/jackal-assets.gemspec

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'jackal-assets/version'
+Gem::Specification.new do |s|
+  s.name = 'jackal-assets'
+  s.version = Jackal::Assets::VERSION.version
+  s.summary = 'Jackal Asset Interface'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'http://github.com/carnivore-rb/jackal-assets'
+  s.description = 'Jackal Assets'
+  s.license = 'Apache 2.0'
+  s.require_path = 'lib'
+  s.add_dependency 'jackal'
+  s.add_dependency 'miasma'
+  s.add_dependency 'miasma-local'
+  s.files = Dir['{lib}/**/**/*'] + %w(jackal-assets.gemspec README.md CHANGELOG.md)
+end

data/lib/jackal-assets.rb

@@ -0,0 +1,12 @@
+require 'miasma'
+require 'miasma-local'
+
+module Jackal
+  # Asset storage helper
+  module Assets
+    autoload :Store, 'jackal-assets/store'
+    autoload :Error, 'jackal-assets/errors'
+  end
+end
+
+require 'jackal-assets/version'

data/lib/jackal-assets/errors.rb

@@ -0,0 +1,12 @@
+require 'jackal-assets'
+
+module Jackal
+  module Assets
+    # General error
+    class Error < StandardError
+      # Object not found
+      class NotFound < Error
+      end
+    end
+  end
+end

data/lib/jackal-assets/store.rb

@@ -0,0 +1,109 @@
+require 'jackal-assets'
+
+module Jackal
+  module Assets
+    # Object storage helper
+    class Store
+
+      # @return [String] bucket name
+      attr_accessor :bucket
+      # @return [Hash] initializer arguments
+      attr_reader :arguments
+      # @return [Object] remote connection if applicable
+      attr_reader :connection
+
+      # Create new instance
+      #
+      # @param args [Hash]
+      # @option args [String] :bucket bucket name
+      # @option args [String] :provider provider name
+      def initialize(args={})
+        @arguments = args.to_smash
+        @connection_arguments = args[:connection]
+        @bucket_name = args[:bucket]
+        setup
+      end
+
+      # @return [String] name of bucket
+      def bucket_name
+        @bucket_name ||
+          Carnivore::Config.get(:jackal, :assets, :bucket)
+      end
+
+      # @return [Smash] connection arguments
+      def connection_arguments
+        (@connection_arguments ||
+          Carnivore::Config.get(:jackal, :assets, :connection) ||
+          Smash.new).to_smash
+      end
+
+      # Setup API connection and storage bucket
+      def setup
+        Carnivore.configure!(:verify)
+        @connection = Miasma.api(
+          connection_arguments.deep_merge(
+            Smash.new(
+              :type => :storage
+            )
+          )
+        )
+        @bucket = @connection.buckets.build(:name => bucket_name).save
+      end
+
+      # Fetch object
+      #
+      # @param key [String]
+      # @return [File]
+      def get(key)
+        remote_file = bucket.files.reload.get(key)
+        if(remote_file)
+          remote_file.body
+        else
+          raise Error::NotFound.new "Remote file does not exist! (<#{bucket}>:#{key})"
+        end
+      end
+
+      # Store object
+      #
+      # @param key [String]
+      # @param file [File]
+      # @return [TrueClass]
+      def put(key, file)
+        remote_file = bucket.files.reload.get(key) ||
+          bucket.files.build(:name => key)
+        remote_file.body = file
+        remote_file.save
+        true
+      end
+
+      # Delete object
+      #
+      # @param key [String]
+      # @return [TrueClass, FalseClass]
+      def delete(key)
+        remote_file = bucket.files.reload.get(key)
+        if(remote_file)
+          remote_file.destroy
+          true
+        else
+          false
+        end
+      end
+
+      # URL for object
+      #
+      # @param key [String]
+      # @param expires_in [Numeric] number of seconds url is valid
+      # @return [String]
+      def url(key, expires_in=nil)
+        remote_file = bucket.files.reload.get(key)
+        if(remote_file)
+          remote_file.url(expires_in)
+        else
+          raise Error::NotFound.new "Remote file does not exist! (<#{bucket}>:#{key})"
+        end
+      end
+
+    end
+  end
+end

data/lib/jackal-assets/version.rb

@@ -0,0 +1,6 @@
+module Jackal
+  module Assets
+    # Current library version
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: jackal-assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jackal
+  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: miasma
+  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: miasma-local
+  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'
+description: Jackal Assets
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- jackal-assets.gemspec
+- lib/jackal-assets.rb
+- lib/jackal-assets/errors.rb
+- lib/jackal-assets/store.rb
+- lib/jackal-assets/version.rb
+homepage: http://github.com/carnivore-rb/jackal-assets
+licenses:
+- Apache 2.0
+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: Jackal Asset Interface
+test_files: []
+has_rdoc: