filepreviews 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a7408ac21741d8efb17755f77472468bd6d13e6
-  data.tar.gz: ce60521dd1b76641a7a723133abb4b90756b3eec
+  metadata.gz: 6eb1b65fbd4cf5f20021e4950f0d4df73d015591
+  data.tar.gz: 227b55edc016cbbf490beb865ac33268acfbbaf0
 SHA512:
-  metadata.gz: 6bdd911b96642df03ec18e1959c91375cf93be015c4d319bba1fb1036cf3a09877d88ba20dbe6860fbe88d70ea6d2f9b2e8b8dfe93fe4e3945c3ed51da2bc565
-  data.tar.gz: 94e34f9354e4fe1c0ec9ec22a0061fbd820a4e37aef5d2a0e1f312fbb820eb6ca6bd6fd3caaabe8f22a87f689b3ebed28795ef45095c59286235d9142bfa0353
+  metadata.gz: 1a30644834d46ef94d4f769202cf466442c8e7089fba78407836ae791c7ee14ac9b875d2396b510639d14ffb28d81bb3a59b1f2ef32a45f5ff8d90da1cb66052
+  data.tar.gz: 74645e901e21768c4f4f9c060e86cb1220d356896fe3828d97d0f667eed7a55c3395cb9902cbd302587eca225027fe0f07d596a1cfdc12a7fbca45fcae03d7b6

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.1.1
-  - 2.0.0
+- 2.1.1
+- 2.0.0
 script: bundle exec rake test
 notifications:
   email: false
@@ -10,3 +10,6 @@ notifications:
     on_failure: always
     channels:
     - irc.freenode.org#rubyonadhd
+env:
+  global:
+    secure: ifm8+ChcdXB9BkuzordGulaZbkhhJzZpiqh8JnzgAg+KRPr/riEMQOi+wKAaJMyHobmQjPWbkUoeTaR4vMi/Sdf1sH2rc4NZHHInrfq6fjhNPI8cpykInhTb7hymBCZCQgXHzJKlnULWwJat7JNXrftq/PXQgWRVGiWmFbbNTw8=

data/Changelog.md

@@ -1,7 +1,17 @@
 # Filepreviews Changelog
 
+## 1.1.0
+
+Released Jun 16, 2014 ([1.1.0](https://github.com/jonahoffline/filepreviews-ruby/tree/v1.1.0)).
+
+* Update API url to use new endpoint
+* Add `Filepreviews::Config` module for passing `api_key` and other future options
+* Add `-k, --api-key` arguments and description for setting `api_key` in the `CLI`
+* Update README with documentation for API key configuration, usage and CLI examples
+* Update version to 1.1.0
+
 ## 1.0.0
 
 Released May 17, 2014 ([1.0.0](https://github.com/jonahoffline/filepreviews-ruby/tree/v1.0.0)).
 
-* Initial Release.
+* Initial Release

data/README.md

@@ -1,7 +1,12 @@
 # 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.
+[![Build Status](https://travis-ci.org/jonahoffline/filepreviews-ruby.svg)](https://travis-ci.org/jonahoffline/filepreviews-ruby)
+[![Gem Version](https://badge.fury.io/rb/filepreviews.svg)](http://badge.fury.io/rb/filepreviews)
+[![Dependency Status](https://gemnasium.com/jonahoffline/filepreviews-ruby.svg)](https://gemnasium.com/jonahoffline/filepreviews-ruby)
+[![Code Climate](https://codeclimate.com/github/jonahoffline/filepreviews-ruby.png)](https://codeclimate.com/github/jonahoffline/filepreviews-ruby)
+[![Inline docs](http://inch-pages.github.io/github/jonahoffline/filepreviews-ruby.png)](http://inch-pages.github.io/github/jonahoffline/filepreviews-ruby)
+[![Gitter chat](https://badges.gitter.im/jonahoffline/filepreviews-ruby.png)](https://gitter.im/jonahoffline/filepreviews-ruby)
 
-[Sign up to beta](http://eepurl.com/To0U1)
+This is the ruby client library for the **Demo API** of [FilePreviews.io](http://filepreviews.io) service. A lot more to come very soon.
 
 ## Installation
 
@@ -18,10 +23,31 @@ Or install it yourself as:
     $ gem install filepreviews
 
 ## Usage
+You can currently use the Filepreviews.io API through this gem without registering your application. However, this may change anytime in the future. 
+
+For additional features and greater customization, register your application for an API key at [Filepreviews.io](http://bit.ly/filepreviews-signup) 
 
-### Example code
+### Configuration
+To configure the gem to use your newly-registered `api_key`, you can use one of the two configuration styles:
+
+Block style:
 ```ruby
+require 'filepreviews'
 
+Filepreviews.configure do |config|
+  config.api_key = 'YOUR_API_KEY'
+end
+```
+
+Simpler style: 
+```ruby
+require 'filepreviews'
+
+Filepreviews.api_key = 'YOUR_API_KEY'
+```
+
+### Basic Example Code
+```ruby
 require 'filepreviews'
 
 url = 'http://pixelhipsters.com/images/pixelhipster_cat.png'
@@ -32,13 +58,21 @@ result.metadata_url
 result.metadata
 ```
 
-#### Options
-You can optinally send an options object.
-
+#### Web Page Screencaptures
 ```ruby
+url = 'http://pixelhipsters.com'
+result = Filepreviews.generate(url)
 
-require 'filepreviews'
+result.preview_url
+result.metadata_url
+result.metadata
+```
 
+
+#### Options
+You can optionally send an options object (per request).
+
+```ruby
 options = {
   size: {
     width: 100,
@@ -57,13 +91,33 @@ result.metadata
 ### Command-Line Application
 Options:
 
-  * -m, --metadata - load metadata response
-  * -v, --version  - display the version
-  * -h, --help     - print help
+  * -k, --api_key [key] - use API key from Filepreviews.io
+  * -m, --metadata      - load metadata response
+  * -v, --version       - display the version
+  * -h, --help          - print help
+
+### Command-Line usage examples
+
+#### Basic use
+	$ filepreviews http://www.pixelhipsters.com
+
+#### With an API Key
+	$ filepreviews --api_key YOUR_API_KEY_HERE http://www.pixelhipsters.com
+
+#### Autoload Full (metadata) Response
+	$ filepreviews -m http://pixelhipsters.com/images/pixelhipster_cat.png
+
+**Note**: This will return a full metadata response, instead of the API's original one that returns the `metadata_url` and `preview_url` urls.
+
 
 ## Author
   * [Jonah Ruiz](http://www.pixelhipsters.com)
 
+## Discussion
+If you have any questions, ideas or jokes:
+
+[![Gitter chat](https://badges.gitter.im/jonahoffline/filepreviews-ruby.png)](https://gitter.im/jonahoffline/filepreviews-ruby)
+
 ## Contributing
 
 Is it worth it? let me fork it

data/lib/filepreviews.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'filepreviews/version'
+require 'filepreviews/config'
 require 'filepreviews/utils'
 require 'filepreviews/http'
 require 'filepreviews/response'
@@ -8,6 +9,8 @@ require 'ostruct'
 # @author Jonah Ruiz <jonah@pixelhipsters.com>
 # Main module for FilePreviews.io library
 module Filepreviews
+  include Filepreviews::Config
+
   # Facade method to call API response
   # @param url [String] image url to convert
   # @param options [Hash<Symbol>] :metada and :image options
@@ -33,7 +36,7 @@ module Filepreviews
   # Default options to be used in API request
   # @return [Hash<symbol>] default options
   def self.default_options
-    { debug: true, metadata: ['all'] }
+    { debug: false, metadata: ['all'] }
   end
 
   # Merges metadata options with supported formats

data/lib/filepreviews/cli.rb

@@ -24,6 +24,11 @@ MSG
       opts.banner  = BANNER
       opts.set_program_name 'Filepreviews.io'
 
+      opts.on('-k', '--api_key [key]', String,
+              'use API key from Filepreviews.io') do |key|
+        Filepreviews.api_key = key
+      end
+
       opts.on('-m', '--metadata', 'load metadata response') do
         @metadata = true
       end

data/lib/filepreviews/config.rb

@@ -0,0 +1,27 @@
+module Filepreviews
+  # @author Jonah Ruiz <jonah@pixelhipsters.com>
+  # Configurable module for API key and options
+  module Config
+    def self.included(base)
+      base.extend(self)
+    end
+
+    # @!attribute api_key
+    # @return [String] API key to be used
+    attr_accessor :api_key
+
+    # Configures api_key and options
+    #   Usage example:
+    #     Filepreviews.configure do |config|
+    #       config.api_key = 'your_api_key_here'
+    #     end
+    #
+    #   Alternate way:
+    #     Filepreviews.api_key = ENV['YOUR_API_KEY']
+    #
+    # @param <api_key> [String] api key to use
+    def configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/filepreviews/http.rb

@@ -7,28 +7,41 @@ module Filepreviews
   # @author Jonah Ruiz <jonah@pixelhipsters.com>
   # Contains http helper module
   module HTTP
-    API_URL = 'https://blimp-previews.herokuapp.com/'
+    API_URL = 'https://api.filepreviews.io/v1/'
     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
-
+    # @param debug [Boolean] flag to log responses into STDOUT
+    # @return [Typhoeus::Connection] configured http client for requests to API
+    def default_connection(url = API_URL, debug = false)
       Faraday.new(url: url) do |conn|
         conn.adapter :typhoeus
-        # conn.response _logger
         conn.headers[:user_agent] = USER_AGENT
+        configure_api_auth_header(conn.headers)
+        configure_logger(conn) if debug
+      end
+    end
+
+    # Configures API Authentication header
+    # @param connection_headers [Faraday::Connection] header block
+    # @return [Faraday::Connection] 'X-API-KEY' header
+    def configure_api_auth_header(connection_headers)
+      if (api_key = Filepreviews.api_key)
+        connection_headers['X-API-KEY'] = api_key
       end
     end
 
+    # Configures logger
+    # @param connection [Faraday::Connection] connection block
+    def configure_logger(connection)
+      connection.response :logger
+    end
+
     # Returns processed metadata, and image attributes params
     # @param params [Hash<Symbol>] metadata and image attributes
     # @return [Hash<Symbol>] processed parameters

data/lib/filepreviews/version.rb

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

data/rubocop.yml

@@ -1,5 +1,8 @@
 MethodLength:
-  Max: 15
+  Max: 20
 
 RegexpLiteral:
   MaxSlashes: 0
+
+LineLength:
+  Max: 80

data/spec/filepreviews/config_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+# Dummy class for testing ::Config module
+class Kawaii
+  extend Filepreviews::Config
+end
+
+describe Filepreviews::Config do
+  let(:config) { Kawaii }
+
+  describe '.api_key' do
+    it 'sets api key' do
+      config.api_key = '666'
+      expect(config.api_key).to eq('666')
+    end
+  end
+
+  describe '.configure' do
+    it 'sets the api_key when used with a block' do
+      config.configure { |conf| conf.api_key = 'kawaii!' }
+      expect(config.api_key).to eq('kawaii!')
+    end
+  end
+end

data/spec/filepreviews/filepreviews_spec.rb

@@ -4,18 +4,48 @@ 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
+  it 'keeps it real, you feels me dawg?' do
+    expect(true).to eq(true)
   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)
+  it 'includes configurable methods from Filepreviews::Config' do
+    expect(file_previews.methods).to include(:api_key, :configure)
+  end
+
+  describe '.generate' do
+    before(:each) { Filepreviews.api_key = nil }
+
+    context 'when used without an api key' do
+      it 'returns a Filepreviews::Response instance' do
+        expect(file_previews.generate(sample_img))
+          .to be_an_instance_of(Filepreviews::Response)
+      end
+    end
+
+    context 'when used with an api key' do
+      it 'returns a Filepreviews::Response instance' do
+        Filepreviews.api_key = ENV['FILEPREVIEWS_API_KEY']
+        response = file_previews.generate(sample_img)
+
+        expect(response.metadata_url).to_not be_nil
+        expect(response.preview_url).to_not be_nil
+        expect(response).to be_an_instance_of(Filepreviews::Response)
+      end
+    end
+
+    context 'when used with an incorrect api key' do
+      it 'returns a Filepreviews::Response instance with an error msg' do
+        Filepreviews.api_key = '666'
+        response = file_previews.generate(sample_img)
+
+        expect(response).to respond_to(:error)
+        expect(response.error).to respond_to(:api_key)
+        expect(response.error.api_key).to include('Invalid API Key.')
+      end
+    end
   end
 end

data/spec/filepreviews/http_spec.rb

@@ -20,4 +20,23 @@ describe Filepreviews::HTTP do
       end
     end
   end
+
+  describe 'configure_api_auth_header' do
+    before(:each) { Filepreviews.api_key = nil }
+    header = { 'User-Agent' => "Filepreviews-Rubygem/#{Filepreviews::VERSION}" }
+
+    context 'when api_key is set' do
+      it 'configures the X-API-KEY header' do
+        Filepreviews.api_key = '666'
+        expect(http.default_connection.headers['X-API-KEY']).to eq('666')
+      end
+    end
+
+    context 'when api_key is not present' do
+      it 'does not add the X-API-KEY header' do
+        expect(http.default_connection.headers['X-API-KEY']).to be_nil
+        expect(http.default_connection.headers).to eq(header)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filepreviews
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonah Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,11 +102,13 @@ files:
 - filepreviews.gemspec
 - lib/filepreviews.rb
 - lib/filepreviews/cli.rb
+- lib/filepreviews/config.rb
 - lib/filepreviews/http.rb
 - lib/filepreviews/response.rb
 - lib/filepreviews/utils.rb
 - lib/filepreviews/version.rb
 - rubocop.yml
+- spec/filepreviews/config_spec.rb
 - spec/filepreviews/filepreviews_spec.rb
 - spec/filepreviews/http_spec.rb
 - spec/filepreviews/utils_spec.rb
@@ -136,6 +138,7 @@ signing_key:
 specification_version: 4
 summary: FilePreviews.io Ruby library and CLI for the service
 test_files:
+- spec/filepreviews/config_spec.rb
 - spec/filepreviews/filepreviews_spec.rb
 - spec/filepreviews/http_spec.rb
 - spec/filepreviews/utils_spec.rb