filepreviews 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a7408ac21741d8efb17755f77472468bd6d13e6
+  data.tar.gz: ce60521dd1b76641a7a723133abb4b90756b3eec
+SHA512:
+  metadata.gz: 6bdd911b96642df03ec18e1959c91375cf93be015c4d319bba1fb1036cf3a09877d88ba20dbe6860fbe88d70ea6d2f9b2e8b8dfe93fe4e3945c3ed51da2bc565
+  data.tar.gz: 94e34f9354e4fe1c0ec9ec22a0061fbd820a4e37aef5d2a0e1f312fbb820eb6ca6bd6fd3caaabe8f22a87f689b3ebed28795ef45095c59286235d9142bfa0353

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.inch
+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/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--fail-fast

data/.ruby-gemset

@@ -0,0 +1 @@
+filepreviews

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+script: bundle exec rake test
+notifications:
+  email: false
+  irc:
+    on_success: change
+    on_failure: always
+    channels:
+    - irc.freenode.org#rubyonadhd

data/Changelog.md

@@ -0,0 +1,7 @@
+# Filepreviews Changelog
+
+## 1.0.0
+
+Released May 17, 2014 ([1.0.0](https://github.com/jonahoffline/filepreviews-ruby/tree/v1.0.0)).
+
+* Initial Release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filepreviews.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonah Ruiz
+
+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,75 @@
+# FilePreviews.io (Ruby client)
+This is the ruby client library for the **Demo API** of [FilePreviews.io](http://filepreviews.io) service. A lot more to come very soon.
+
+[Sign up to beta](http://eepurl.com/To0U1)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'filepreviews'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filepreviews
+
+## Usage
+
+### Example code
+```ruby
+
+require 'filepreviews'
+
+url = 'http://pixelhipsters.com/images/pixelhipster_cat.png'
+result = Filepreviews.generate(url)
+
+result.preview_url
+result.metadata_url
+result.metadata
+```
+
+#### Options
+You can optinally send an options object.
+
+```ruby
+
+require 'filepreviews'
+
+options = {
+  size: {
+    width: 100,
+    height: 999
+  },
+  # supported: 'exif', 'ocr', 'psd' or 'all' which means everything
+  metadata: ['exif', 'ocr', 'psd']
+}
+
+result = FilePreviews.generate(url, options)
+result.preview_url
+result.metadata_url
+result.metadata
+```
+
+### Command-Line Application
+Options:
+
+  * -m, --metadata - load metadata response
+  * -v, --version  - display the version
+  * -h, --help     - print help
+
+## Author
+  * [Jonah Ruiz](http://www.pixelhipsters.com)
+
+## Contributing
+
+Is it worth it? let me fork it
+
+I put my thing down, flip it and debug it
+
+Ti gubed dna ti pilf nwod gniht ym tup I
+
+Ti gubed dna ti pilf nwod gniht ym tup I

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/bin/filepreviews

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# @author Jonah Ruiz <jonah@pixelhipsters.com>
+# Command-line application for Filepreviews.io
+
+Signal.trap('INT') { exit 1 }
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib/'
+require 'filepreviews'
+require 'filepreviews/cli'
+
+puts Filepreviews::CLI.new(ARGV).parse

data/filepreviews.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filepreviews/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'filepreviews'
+  spec.version       = Filepreviews::VERSION
+  spec.authors       = ['Jonah Ruiz']
+  spec.email         = ['jonah@pixelhipsters.com']
+  spec.description   = %q(FilePreviews.io Ruby library and CLI application.)
+  spec.summary       = %q(FilePreviews.io Ruby library and CLI for the service)
+  spec.homepage      = 'https://github.com/jonahoffline/filepreviews-ruby'
+  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{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'typhoeus', '~> 0.6.8'
+end

data/lib/filepreviews.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'filepreviews/version'
+require 'filepreviews/utils'
+require 'filepreviews/http'
+require 'filepreviews/response'
+require 'ostruct'
+
+# @author Jonah Ruiz <jonah@pixelhipsters.com>
+# Main module for FilePreviews.io library
+module Filepreviews
+  # Facade method to call API response
+  # @param url [String] image url to convert
+  # @param options [Hash<Symbol>] :metada and :image options
+  # @return [Filepreviews::Response] api response object
+  def self.generate(url, options = {})
+    request_hash = prepare_options(url, options)
+    Filepreviews::HTTP.fetch(request_hash)
+  end
+
+  protected
+
+  # Prepares url and parameters for request
+  #  it calls defaults if nothing is provided
+  # @param url [String] url
+  # @param params [Hash<symbol>] options
+  # @return [OpenStruct] all options as methods
+  def self.prepare_options(url, params)
+    params = merge_options(params.fetch(:options) { default_options })
+    params.merge!(url: url)
+    OpenStruct.new(params)
+  end
+
+  # Default options to be used in API request
+  # @return [Hash<symbol>] default options
+  def self.default_options
+    { debug: true, metadata: ['all'] }
+  end
+
+  # Merges metadata options with supported formats
+  # @param options [Hash<symbol>] metadata and optional size
+  def self.merge_options(options)
+    metadata = (options.fetch(:metadata) & metadata_formats)
+    options.store(:metadata, metadata)
+
+    default_options.merge(options)
+  end
+
+  # Supported (image) formats in metadata
+  # @return [Array] image file extensions
+  def self.metadata_formats
+    %w(all exif ocr psd)
+  end
+end

data/lib/filepreviews/cli.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+
+module Filepreviews
+  # @author Jonah Ruiz <jonah@pixelhipsters.com>
+  # A Simple class for the executable version of the gem
+  class CLI
+    BANNER = <<MSG
+Usage: filepreviews [OPTION] [URL]
+Description:
+Filepreviews.io - Thumbnails and metadata for almost any kind of file
+
+Options:
+MSG
+    # Passes arguments from ARGV and sets metadata flag
+    # @param args [Array<String>] The command-line arguments
+    def initialize(args)
+      @args, @metadata = args, false
+    end
+
+    # Configures the arguments for the command
+    # @param opts [OptionParser]
+    def options(opts)
+      opts.version = Filepreviews::VERSION
+      opts.banner  = BANNER
+      opts.set_program_name 'Filepreviews.io'
+
+      opts.on('-m', '--metadata', 'load metadata response') do
+        @metadata = true
+      end
+
+      opts.on_tail('-v', '--version', 'display the version of Filepreviews') do
+        puts opts.version
+        exit
+      end
+
+      opts.on_tail('-h', '--help', 'print this help') do
+        puts opts.help
+        exit
+      end
+    end
+
+    # Parses options sent from command-line
+    def parse
+      opts = OptionParser.new(&method(:options))
+      opts.parse!(@args)
+      return opts.help if @args.last.nil?
+
+      file_preview = Filepreviews.generate(@args.last)
+      @metadata ? file_preview.metadata(js: true) : file_preview
+    end
+  end
+end

data/lib/filepreviews/http.rb

@@ -0,0 +1,56 @@
+require 'json'
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+module Filepreviews
+  # @author Jonah Ruiz <jonah@pixelhipsters.com>
+  # Contains http helper module
+  module HTTP
+    API_URL = 'https://blimp-previews.herokuapp.com/'
+    USER_AGENT = "Filepreviews-Rubygem/#{Filepreviews::VERSION}"
+
+    include Filepreviews::Utils
+
+    module_function
+
+    # TODO: Fix logger
+    # Returns custom Typhoeus connection configuration
+    # @param url [String] API url to be used as base
+    # @param _debug [Boolean] flag to log responses into STDOUT
+    # @return [Typhoeus::Connection] http client for requests to API
+    def default_connection(url = API_URL, _debug = true)
+      # _logger = debug ? :logger : false
+
+      Faraday.new(url: url) do |conn|
+        conn.adapter :typhoeus
+        # conn.response _logger
+        conn.headers[:user_agent] = USER_AGENT
+      end
+    end
+
+    # Returns processed metadata, and image attributes params
+    # @param params [Hash<Symbol>] metadata and image attributes
+    # @return [Hash<Symbol>] processed parameters
+    def prepare_request(params)
+      request = process_params(params)
+      request.store(:size, extract_size(params.size)) if params.size
+      request
+    end
+
+    # Returns parsed response from API
+    # @return [Filepreviews::Response] json response as callable methods
+    def fetch(params)
+      response = default_connection(API_URL, params.debug)
+                   .get nil, prepare_request(params)
+      parse(response.body)
+    end
+
+    # Returns callable methods from parsed JSON response
+    # @param response_body [String<JSON>] stringified version of json response
+    # @return [Filepreviews::Response] json response as callable methods
+    def parse(response_body)
+      Filepreviews::Response.new(JSON.parse(response_body))
+    end
+  end
+end

data/lib/filepreviews/response.rb

@@ -0,0 +1,36 @@
+module Filepreviews
+# @author Jonah Ruiz <jonah@pixelhipsters.com>
+# Response module to create callable methods from JSON response
+  class Response < OpenStruct
+    # Overrides OpenStruct#initialize to enable deep nesting
+    # @param hash [Hash<symbol>] JSON response body
+    # @return [Filepreviews::Response] inherited/hack version of OpenStruct
+    # @see OpenStruct#initialize
+    def initialize(hash = nil)
+      @table, @hash_table = {}, {}
+
+      if hash
+        hash.each do |k, v|
+          @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+          @hash_table[k.to_sym] = v
+          new_ostruct_member(k)
+        end
+      end
+    end
+
+    # Magical method to give OpenStruct-like class deep nesting capability
+    def to_h
+      @hash_table
+    end
+
+    # Returns metadata response using the metadata_url from first response
+    #   flag is used to share this method with the CLI version (puerco, I know)
+    # @param js [Boolean] flag to enable json response
+    # @return [Filepreviews::Response] api response object
+    def metadata(js: false)
+      url = send(:metadata_url)
+      response = Filepreviews::HTTP.default_connection(url).get(nil)
+      js ? JSON.parse(response.body) : Filepreviews::HTTP.parse(response.body)
+    end
+  end
+end

data/lib/filepreviews/utils.rb

@@ -0,0 +1,39 @@
+require 'ostruct'
+require 'cgi'
+
+module Filepreviews
+# @author Jonah Ruiz <jonah@pixelhipsters.com>
+# Utility module with helper methods
+  module Utils
+    def self.included(base)
+      base.extend(self)
+    end
+
+    # Extracts metadata parameters
+    # @param metadata [Array] image formats
+    # @return [String] metadata url parameters
+    def extract_metadata(metadata)
+      metadata.join(',')
+    end
+
+    # Extracts the desired image size attributes
+    # @param size [Hash<Symbol>] desired image :width and :height
+    # @return [String] combined width and height size for http request
+    def extract_size(size)
+      unless size.nil?
+        size = OpenStruct.new(size)
+        "#{size.width}x#{size.height}"
+      end
+    end
+
+    # Returns processed options and url as parameters
+    # @param params [Hash<Symbol>] :url and :metadata
+    # @return [Hash<Symbol>] processed parameters for http request
+    def process_params(params)
+      {
+        url: CGI.unescape(params.url),
+        metadata: extract_metadata(params.metadata)
+      }
+    end
+  end
+end

data/lib/filepreviews/version.rb

@@ -0,0 +1,5 @@
+# @author Jonah Ruiz <jonah@pixelhipsters.com>
+# Contains the version namespaced
+module Filepreviews
+  VERSION = '1.0.0'
+end

data/rubocop.yml

@@ -0,0 +1,5 @@
+MethodLength:
+  Max: 15
+
+RegexpLiteral:
+  MaxSlashes: 0

data/spec/filepreviews/filepreviews_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Filepreviews do
+  let(:file_previews) { Filepreviews }
+  let(:sample_img) { 'http://pixelhipsters.com/images/pixelhipster_cat.png' }
+
+  describe '.generate' do
+    it 'returns a Filepreviews::Response instance' do
+      expect(file_previews.generate(sample_img))
+        .to be_an_instance_of(Filepreviews::Response)
+    end
+  end
+
+  it 'has a version number' do
+    expect(Filepreviews::VERSION).not_to be nil
+  end
+
+  it 'keeps it real, you feels me dawg?' do
+    expect(true).to eq(true)
+  end
+end

data/spec/filepreviews/http_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Filepreviews::HTTP do
+  let(:http) { Filepreviews::HTTP }
+
+  describe '.default_connection' do
+    it 'returns a Faraday connection instance' do
+      expect(http.default_connection).to be_an_instance_of(Faraday::Connection)
+    end
+
+    context 'Overrides Faraday defaults' do
+      it 'configures UserAgent header' do
+        expect(http.default_connection.headers.fetch('User-Agent'))
+          .to eq(Filepreviews::HTTP::USER_AGENT)
+      end
+
+      it 'configures the Typhoeus Adapter' do
+        expect(http.default_connection.builder.handlers)
+          .to include(Faraday::Adapter::Typhoeus)
+      end
+    end
+  end
+end

data/spec/filepreviews/utils_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+# Dummy class for testing Utils module
+class Kawaii
+  include Filepreviews::Utils
+end
+
+describe Filepreviews::Utils do
+  let(:kawaii) { Kawaii.new }
+
+  describe '.process_params' do
+    it 'returns extracted parameter hash with :url and :metadata' do
+      url = 'https://www.filepicker.io/api/file/0ehaqJwCTSq4P6jMrix6'
+      params = OpenStruct.new(url: url, metadata: ['png'])
+
+      expect(kawaii.process_params(params))
+        .to eq(url: url, metadata: 'png')
+    end
+  end
+
+  describe '.extract_size' do
+    it 'returns extracted image parameters combined' do
+      size = { width: 320, height: 240 }
+      expect(Kawaii.new.extract_size(size)).to eq('320x240')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'filepreviews'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: filepreviews
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonah Ruiz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+description: FilePreviews.io Ruby library and CLI application.
+email:
+- jonah@pixelhipsters.com
+executables:
+- filepreviews
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/filepreviews
+- filepreviews.gemspec
+- lib/filepreviews.rb
+- lib/filepreviews/cli.rb
+- lib/filepreviews/http.rb
+- lib/filepreviews/response.rb
+- lib/filepreviews/utils.rb
+- lib/filepreviews/version.rb
+- rubocop.yml
+- spec/filepreviews/filepreviews_spec.rb
+- spec/filepreviews/http_spec.rb
+- spec/filepreviews/utils_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jonahoffline/filepreviews-ruby
+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: FilePreviews.io Ruby library and CLI for the service
+test_files:
+- spec/filepreviews/filepreviews_spec.rb
+- spec/filepreviews/http_spec.rb
+- spec/filepreviews/utils_spec.rb
+- spec/spec_helper.rb