inky 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73dfc9c82a669d92077f6ed7c56e6be5c47cb09e
+  data.tar.gz: ea0a899b7ddfe49302628c9480b5e5bd81cf73c4
+SHA512:
+  metadata.gz: fe7c749ebca1d1b70dd077d23a111fc6df6a522b4082b5fe5e93b899faf9469ac5d039ed8559e85f7ea444d003b456c1cc84b94bc568df7b9e26f661ebc7cd27
+  data.tar.gz: c88bc15d94fe7dfcf5d9412e2257a7f3eaa06e84c3fb372aeaf8c30b4788ee59426d9488f75db341ceda054539de2d6563874c78ffacbf26d3bd015da0372df5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/README.md

@@ -0,0 +1,95 @@
+## Inky
+
+A ruby client for [filepicker.io](http://filepicker.io). Built on top of the Filepicker
+[REST API](https://developers.filepicker.io/docs/web/rest/).
+
+### Installation
+
+Add this to your gemfile.rb:
+
+```
+gem 'inky'
+```
+
+### Basic Usage
+
+How to view information about existing files.
+
+```ruby
+file = Inky::File.new('hFHUCB3iTxyMzseuWOgG')
+file.uid
+file.md5
+file.mimetype
+file.uploaded
+file.container
+file.writeable
+file.filename
+file.location
+file.key
+file.path
+file.size
+
+file.metadata # hash of all available metadata
+```
+
+### Storing files
+
+First, authorize your Filepicker account. You must have a paid plan for cloud storage to work.
+
+```ruby
+Inky.authorize! 'MyApiKey1234455665'
+```
+
+To upload a local file:
+
+```ruby
+Inky::File.from_file(File.open('my_file.png')).save!
+
+# this is equivalent to:
+file = Inky::File.new
+file.local_file = File.open('my_file.png')
+file.save!
+```
+
+To save from a URL:
+
+```ruby
+Inky::File.from_url('http://example.com/my_file.png').save!
+
+# this is equivalent to:
+file = Inky::File.new
+file.remote_url = 'http://example.com/my_file.png'
+file.save!
+```
+
+### Configuration
+
+```ruby
+# file#save accepts several options:
+file.save! location: 'S3', # Other options include 'azure', 'rackspace', 'dropbox'
+           filename: 'my_cool_file.ogg',
+           mimetype: 'application/ogg',
+           path: '/my_cool_files/1234.png', # path to store on cloud storage
+           container: 'myapp-development', # container/bucket on cloud storage
+           access: 'public' # defaults to 'private'
+```
+
+### Updating an existing file
+
+`file.save!` can be used to update an existing file with new content from a local file or url:
+
+```ruby
+# Updating an existing file
+file = Inky::File.new('hFHUCB3iTxyMzseuWOgG')
+file.local_file = File.open('my_new_file.ogg')
+file.save!
+
+file = Inky::File.new('hFHUCB3iTxyMzseuWOgG')
+file.remote_url = 'http://example.com/my_new_file.ogg'
+file.save!
+```
+
+### Todo
+
+* Support security policies
+* Support basic/temporary FP uploads (without S3/cloud storage)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/inky.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inky/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'inky'
+  spec.version       = Inky::VERSION
+  spec.authors       = ['Smudge']
+  spec.email         = ['nathan@ngriffith.com']
+  spec.summary       = "A ruby client for filepicker.io's REST API"
+  spec.description   = "A ruby client for filepicker.io's REST API"
+  spec.homepage      = ''
+  spec.license       = ''
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'addressable', '>= 2.2.0'
+  spec.add_dependency 'rest-client', '>= 1.7.0'
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+end

data/lib/inky.rb

@@ -0,0 +1,12 @@
+require_relative 'inky/file'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Inky
+  BASE_URL = 'https://www.filepicker.io/api'
+
+  mattr_accessor :api_key
+
+  def self.authorize!(api_key)
+    self.api_key = api_key
+  end
+end

data/lib/inky/file.rb

@@ -0,0 +1,80 @@
+require 'rest_client'
+require 'addressable/uri'
+
+module Inky
+  class File
+    METADATA_FIELDS = :md5, :mimetype, :uploaded, :container, :writeable,
+                      :filename, :location, :key, :path, :size, :width,
+                      :height
+    MF_ARGS = METADATA_FIELDS.each_with_object({}) { |f, h| h[f] = true }
+
+    attr_accessor(*METADATA_FIELDS)
+    attr_accessor :uid, :local_file, :remote_url, :metadata
+
+    def initialize(value = nil)
+      return unless value
+      self.uid = value
+      request_metadata
+    end
+
+    def self.from_file(file)
+      self.local_file = value
+    end
+
+    def self.from_url(url)
+      self.remote_url = value
+    end
+
+    def url
+      "#{BASE_URL}/file/#{uid}"
+    end
+
+    def save!(opts = {})
+      opts = { location: 's3', key: Inky.api_key }.merge(opts)
+      handle_post_response RestClient.post(post_url(opts), post_opts)
+      self
+    end
+
+  private
+
+    def post_url(opts)
+      location = opts.delete(:location)
+      post_url = Addressable::URI.parse(uid ? url : store_url(location))
+      post_url.query_values = opts
+      post_url.to_s
+    end
+
+    def post_opts
+      { url: remote_url, fileUpload: local_file }.delete_if { |_, v| v.nil? }
+    end
+
+    def handle_post_response(response)
+      self.uid = JSON.parse(response)['url'].split('/').last
+      request_metadata
+      self.remote_url = self.local_file = nil
+    end
+
+    def store_url(location)
+      "#{BASE_URL}/store/#{location}"
+    end
+
+    def request_metadata
+      return unless uid
+      response = RestClient.get "#{url}/metadata", params: MF_ARGS
+      self.metadata = JSON.parse(response)
+      METADATA_FIELDS.each { |f| send("#{f}=", metadata[f.to_s]) }
+    end
+
+    def valid_url?(url)
+      (parsed = Addressable::URI.parse(url)) &&
+        %w(http https).include?(parsed.scheme)
+    rescue Addressable::URI::InvalidURIError
+      false
+    end
+  end
+end
+
+
+# Inky.authorize!('AEqf74BETRAuJWYy1U4hqz'); f = Inky::File.new('2zSX2El5QOatv87CNXxt')
+# Inky.authorize!('AEqf74BETRAuJWYy1U4hqz'); f = Inky::File.from_url('https://www.filepicker.io/api/file/2zSX2El5QOatv87CNXxt')
+# Inky.authorize!('AEqf74BETRAuJWYy1U4hqz'); f = Inky::File.from_file(File.open('my_file.txt'))

data/lib/inky/version.rb

@@ -0,0 +1,3 @@
+module Inky
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: inky
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Smudge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A ruby client for filepicker.io's REST API
+email:
+- nathan@ngriffith.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- inky.gemspec
+- lib/inky.rb
+- lib/inky/file.rb
+- lib/inky/version.rb
+homepage: ''
+licenses:
+- ''
+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: A ruby client for filepicker.io's REST API
+test_files: []
+has_rdoc: