filepreviews 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42c0103985289f8faa7d99d4860b8f921ba60f47
-  data.tar.gz: 1eaadf4c3e6fae2bfed7a1a7c7a64f4dde0fcd1e
+  metadata.gz: 546e8d302d532f3d59e47303370a194f098095be
+  data.tar.gz: 5e68cfdc503bb10fd36b0ed7f7e87f55c99093f6
 SHA512:
-  metadata.gz: 177adaded1998f11e606c4791b4d1762d5b44fa1c92926da18fb2de748958f3cbae8dd867c3ea43881c56de43e232232b107525ba1b9e729ade70945c606e51e
-  data.tar.gz: fe4e2041b2690f420f18db0c4d8c6a5d7bd0647487b7a9eb6897e7f3a5d1f86955bc841d389578af100a1782974253b932d2455ca7c368de7c68b2e42ffc162e
+  metadata.gz: ebd3b87732db306fc5849a5009bbe6855fe70a0efba217fddf01846006a63368e39ac7fa1df5c43d444d8e7e352362b388b954cda471c119e7941e8f3797dd33
+  data.tar.gz: 484ac6d498dffd8444f4d701d9ee5ec4d935bce614e814978b341560c2126299acaa4a8bda8700627623712a510578dd49d123e2922dd4984184c8f46e8e674d

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.o
 *.a
 mkmf.log
+*.*.env

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
 - 2.1.1
 - 2.0.0
@@ -12,4 +13,5 @@ notifications:
     - irc.freenode.org#rubyonadhd
 env:
   global:
-    secure: ifm8+ChcdXB9BkuzordGulaZbkhhJzZpiqh8JnzgAg+KRPr/riEMQOi+wKAaJMyHobmQjPWbkUoeTaR4vMi/Sdf1sH2rc4NZHHInrfq6fjhNPI8cpykInhTb7hymBCZCQgXHzJKlnULWwJat7JNXrftq/PXQgWRVGiWmFbbNTw8=
+  - secure: ksz/xSq5EkiWQfclYHh5gj32IjqH5uTXacYqFGZdpZWPtkxGscSVeBzAvGtY9IQddkEuobVEW8TBqPo2rZ+7sT6ZfLQOuNM9Vtw5jDbAifyHLivZ5/acnW7m5BcmkxttKrel4DfRexzvGW6SAweE+fC07BLfPjzyKoIyjKnV4Y8=
+  - secure: lYcTOY21MNhFAvd3mCNj0CBoMJYMLGy+PsNcuLvhNcQHw/+ulkzQITJFo9IaAOl8TXv+ETAfay0eXfzVC8hE8DTeq3QovdocciMa+otCpVQWRzDwfc+mfUqutdgn96CjAmkvGYHwkDf/X4LBRaDhI2beKeaGO/BGQZw+NMEBFzo=

data/Changelog.md

@@ -1,5 +1,18 @@
 # Filepreviews Changelog
 
+## 2.0.0
+
+Released Sept 17, 2015 ([2.0.0](https://github.com/jonahoffline/filepreviews-ruby/tree/v2.0.0)).
+
+* Change API base url
+* Add `generate_auth_key` for generating Authorization header
+* Remove `:metadata` options: `all`
+* Add `:pages` validator
+* Add default `:pages` (`1`) and `:metadata` (`exif`)
+* Update README to include new `secret_key` options for `lib` and `cli`
+* Update encrypted `api key` and add `secret key` for Travis-CI.
+* Update version to 2.0.0
+
 ## 1.2.0
 
 Released Jun 26, 2014 ([1.2.0](https://github.com/jonahoffline/filepreviews-ruby/tree/v1.2.0)).

data/README.md

@@ -6,7 +6,7 @@
 [![Gitter chat](https://img.shields.io/badge/gitter-filepreviews--ruby-blue.svg?style=flat)](https://gitter.im/jonahoffline/filepreviews-ruby)
 [![Inline docs](http://inch-ci.org/github/jonahoffline/filepreviews-ruby.png)](http://inch-ci.org/github/jonahoffline/filepreviews-ruby)
 
-This is the ruby client library for the **Demo API** of [FilePreviews.io](http://filepreviews.io) service. A lot more to come very soon.
+This is the ruby client library for the [FilePreviews.io](http://filepreviews.io) API. A lot more to come very soon.
 
 ## Installation
 
@@ -23,12 +23,12 @@ 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. 
+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) 
+For additional features and greater customization, register your application for an API key at [Filepreviews.io](http://bit.ly/filepreviews-signup)
 
 ### Configuration
-To configure the gem to use your newly-registered `api_key`, you can use one of the two configuration styles:
+To configure the gem to use your newly-registered `api + secret keys`, you can use one of the two configuration styles:
 
 Block style:
 ```ruby
@@ -36,14 +36,16 @@ require 'filepreviews'
 
 Filepreviews.configure do |config|
   config.api_key = 'YOUR_API_KEY'
+  config.secret_key = 'YOUR_SECRET_KEY'
 end
 ```
 
-Simpler style: 
+Simpler style:
 ```ruby
 require 'filepreviews'
 
 Filepreviews.api_key = 'YOUR_API_KEY'
+Filepreviews.config.secret_key = 'YOUR_SECRET_KEY'
 ```
 
 ### Basic Example Code
@@ -53,9 +55,9 @@ require 'filepreviews'
 url = 'http://pixelhipsters.com/images/pixelhipster_cat.png'
 result = Filepreviews.generate(url)
 
-result.preview_url
-result.metadata_url
-result.metadata
+result.url
+result.status
+result.metadata # fetches metadata
 ```
 
 #### Web Page Screencaptures
@@ -63,8 +65,8 @@ result.metadata
 url = 'http://pixelhipsters.com'
 result = Filepreviews.generate(url)
 
-result.preview_url
-result.metadata_url
+result.url
+result.status
 result.metadata
 ```
 
@@ -80,24 +82,26 @@ conf = {
       height: 999
     },
     # supported: 'exif', 'ocr', 'psd', 'checksum', 'multimedia',
-    # and 'all' which means everything
-    metadata: ['exif', 'ocr', 'psd'],
+    metadata: ['exif'],
 
     # supported: 'jpg', 'jpeg', 'png'
-    format: 'jpg'
+    format: 'jpg',
+
+    # supported: '1', '1-3', '1,3,5', '1-3', 'all'
+    pages: '1-3'
   }
 }
 
-result = FilePreviews.generate(url, conf)
-result.preview_url
-result.metadata_url
+result = Filepreviews.generate(url, conf)
+result.url
 result.metadata
 ```
 
 ### Command-Line Application
 Options:
 
-  * -k, --api_key [key] - use API key from Filepreviews.io
+  * -k, --api_key    [key] - use API key from Filepreviews.io
+  * -s, --secret_key [key] - use secret key from Filepreviews.io
   * -m, --metadata      - load metadata response
   * -v, --version       - display the version
   * -h, --help          - print help
@@ -108,12 +112,12 @@ Options:
 	$ filepreviews http://www.pixelhipsters.com
 
 #### With an API Key
-	$ filepreviews --api_key YOUR_API_KEY_HERE http://www.pixelhipsters.com
+	$ filepreviews --api_key YOUR_API_KEY_HERE --secret_key YOUR_SECRET_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.
+**Note**: This will return a full metadata response, instead of the API's original response that only returns the `url` and `status` of the request.
 
 
 ## Author

data/lib/filepreviews.rb

@@ -10,6 +10,7 @@ require 'ostruct'
 # Main module for FilePreviews.io library
 module Filepreviews
   include Filepreviews::Config
+  include Filepreviews::Utils
 
   # Facade method to call API response
   # @param url [String] image url to convert
@@ -36,25 +37,28 @@ module Filepreviews
   # Default options to be used in API request
   # @return [Hash<symbol>] default options
   def self.default_options
-    { debug: false, metadata: ['all'] }
+    { debug: false, pages: '1' }
   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)
+    metadata = (options.fetch(:metadata, ['exif']) & metadata_formats)
+    options.store(:metadata, metadata) unless metadata.empty?
 
     image = (options.fetch(:format) if image_formats.include?(options[:format]))
     options.store(:format, image)
 
+    pages = (options.fetch(:pages, '1'))
+    options.store(:pages, validate_pages(pages))
+
     default_options.merge(options)
   end
 
   # Supported (image) formats in metadata
   # @return [Array] image file extensions
   def self.metadata_formats
-    %w(all exif ocr psd checksum multimedia)
+    %w(exif ocr psd checksum multimedia)
   end
 
   # Supported extracted (image) thumbnail formats

data/lib/filepreviews/cli.rb

@@ -25,8 +25,13 @@ MSG
       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
+              'use API key from Filepreviews.io') do |api_key|
+        Filepreviews.api_key = api_key
+      end
+
+      opts.on('-s', '--secret_key [key]', String,
+              'use Secret key from Filepreviews.io') do |secret_key|
+        Filepreviews.secret_key = secret_key
       end
 
       opts.on('-m', '--metadata', 'load metadata response') do

data/lib/filepreviews/config.rb

@@ -6,20 +6,22 @@ module Filepreviews
       base.extend(self)
     end
 
-    # @!attribute api_key
-    # @return [String] API key to be used
-    attr_accessor :api_key
+    # @!attribute api_key, :secret_key
+    # @return [String] API/Secret key to be used
+    attr_accessor :api_key, :secret_key
 
     # Configures api_key and options
     #   Usage example:
     #     Filepreviews.configure do |config|
     #       config.api_key = 'your_api_key_here'
+    #       config.secret_key = 'your_api_key_here'
     #     end
     #
     #   Alternate way:
     #     Filepreviews.api_key = ENV['YOUR_API_KEY']
+    #     Filepreviews.secret_key = ENV['YOUR_SECRET_KEY']
     #
-    # @param <api_key> [String] api key to use
+    # @param <api_key> [String] api/secret key to use
     def configure
       yield self if block_given?
     end

data/lib/filepreviews/http.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'base64'
 require 'faraday'
 require 'typhoeus'
 require 'typhoeus/adapters/faraday'
@@ -7,7 +8,7 @@ module Filepreviews
   # @author Jonah Ruiz <jonah@pixelhipsters.com>
   # Contains http helper module
   module HTTP
-    API_URL = 'https://api.filepreviews.io/v1/'
+    BASE_URL = 'https://api.filepreviews.io'
     USER_AGENT = "Filepreviews-Rubygem/#{Filepreviews::VERSION}"
 
     include Filepreviews::Utils
@@ -18,7 +19,7 @@ module Filepreviews
     # @param url [String] API url to be used as base
     # @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)
+    def default_connection(url = BASE_URL, debug = false)
       Faraday.new(url: url) do |conn|
         conn.adapter :typhoeus
         conn.headers[:user_agent] = USER_AGENT
@@ -28,12 +29,25 @@ module Filepreviews
       end
     end
 
+    # Returns API Keys status
+    # @return [Boolean] for when API keys are configured
+    def api_keys?
+      !!(Filepreviews.api_key && Filepreviews.secret_key)
+    end
+
+    # Configures API HTTP Basic Authentication
+    # @return [String] HTTP Auth string for header
+    def generate_auth_key
+      key = Base64.encode64("#{Filepreviews.api_key}:#{Filepreviews.secret_key}").gsub(/\n/, '')
+      "Basic #{key}"
+    end
+
     # Configures API Authentication header
     # @param connection_headers [Faraday::Connection] header block
-    # @return [Faraday::Connection] 'X-API-KEY' header
+    # @return [Faraday::Connection] 'Authorization' header
     def configure_api_auth_header(connection_headers)
-      if (api_key = Filepreviews.api_key)
-        connection_headers['X-API-KEY'] = api_key
+      if api_keys?
+        connection_headers['Authorization'] = generate_auth_key
       end
     end
 
@@ -55,10 +69,14 @@ module Filepreviews
 
     # Returns parsed response from API
     # @return [Filepreviews::Response] json response as callable methods
-    def fetch(params)
+    def fetch(params, endpoint_path = 'previews')
       options = prepare_request(params)
-      response = default_connection(API_URL, params.debug)
-                   .post { |req| req.body = JSON.generate(options) }
+      response = default_connection(BASE_URL, params.debug)
+                   .post do |req|
+                    req.url("/v2/#{endpoint_path}/")
+                     req.body = JSON.generate(options)
+                   end
+
       parse(response.body)
     end
 

data/lib/filepreviews/response.rb

@@ -7,6 +7,18 @@ module Filepreviews
     # @return [Filepreviews::Response] inherited/hack version of OpenStruct
     # @see OpenStruct#initialize
     def initialize(hash = nil)
+      responsify(hash)
+    end
+
+    # Magical method to give OpenStruct-like class deep nesting capability
+    def to_h
+      @hash_table
+    end
+
+    # @param hash [Hash<symbol>] JSON response body
+    # @return [Filepreviews::Response] inherited/hack version of OpenStruct
+    # @see OpenStruct#initialize
+    def responsify(hash = nil)
       @table, @hash_table = {}, {}
 
       if hash
@@ -18,19 +30,16 @@ module Filepreviews
       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
+    # Returns metadata response using the 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)
+      url = send(:url)
       response = Filepreviews::HTTP.default_connection(url).get(nil)
-      js ? JSON.parse(response.body) : Filepreviews::HTTP.parse(response.body)
+      json = JSON.parse(response.body)
+
+      js ? json : self.responsify(json)
     end
   end
 end

data/lib/filepreviews/utils.rb

@@ -13,7 +13,20 @@ module Filepreviews
     # @param metadata [Array] image formats
     # @return [String] metadata url parameters
     def extract_metadata(metadata)
-      metadata.join(',')
+      if metadata.class.eql?(Array)
+        metadata.join(',')
+      else
+        metadata
+      end
+    end
+
+    # Validates page parameters
+    # @param pages [Array] page parameters
+    # @return [String] page thumbnail parameters
+    def validate_pages(pages)
+      if !!(pages =~ /,/) || !!(pages =~ /-/) || pages.eql?('all') || pages =~ /\d/
+        pages
+      end
     end
 
     # Extracts the desired image size attributes

data/lib/filepreviews/version.rb

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

data/spec/filepreviews/config_spec.rb

@@ -15,10 +15,22 @@ describe Filepreviews::Config do
     end
   end
 
+  describe '.secret_key' do
+    it 'sets secret key' do
+      config.secret_key = '666'
+      expect(config.secret_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!' }
+      config.configure do |conf|
+        conf.api_key = 'kawaii!'
+        conf.secret_key = 'not-kawaii!'
+      end
+
       expect(config.api_key).to eq('kawaii!')
+      expect(config.secret_key).to eq('not-kawaii!')
     end
   end
 end

data/spec/filepreviews/filepreviews_spec.rb

@@ -13,11 +13,14 @@ describe Filepreviews do
   end
 
   it 'includes configurable methods from Filepreviews::Config' do
-    expect(file_previews.methods).to include(:api_key, :configure)
+    expect(file_previews.methods).to include(:api_key, :secret_key, :configure)
   end
 
   describe '.generate' do
-    before(:each) { Filepreviews.api_key = nil }
+    before(:each) do
+      Filepreviews.api_key = nil
+      Filepreviews.secret_key = nil
+    end
 
     context 'when used without an api key' do
       it 'returns a Filepreviews::Response instance' do
@@ -29,10 +32,11 @@ describe Filepreviews do
     context 'when used with an api key' do
       it 'returns a Filepreviews::Response instance' do
         Filepreviews.api_key = ENV['FILEPREVIEWS_API_KEY']
+        Filepreviews.secret_key = ENV['FILEPREVIEWS_SECRET_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.url).to_not be_nil
+        expect(response.id).to_not be_nil
         expect(response).to be_an_instance_of(Filepreviews::Response)
       end
     end
@@ -40,11 +44,30 @@ describe Filepreviews do
     context 'when used with an incorrect api key' do
       it 'returns a Filepreviews::Response instance with an error msg' do
         Filepreviews.api_key = '666'
+        Filepreviews.secret_key = '777'
         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.')
+        expect(response.error).to respond_to(:message)
+        expect(response.error).to respond_to(:type)
+
+        expect(response.error.message).to eq('Invalid API Key provided.')
+        expect(response.error.type).to eq('invalid_request_error')
+      end
+    end
+
+    context 'when used with incomplete keys' do
+      it 'returns a Filepreviews::Response instance with an error msg' do
+        Filepreviews.api_key = '666'
+        # Filepreviews.secret_key = nil
+        response = file_previews.generate(sample_img)
+
+        expect(response).to respond_to(:error)
+        expect(response.error).to respond_to(:message)
+        expect(response.error).to respond_to(:type)
+
+        expect(response.error.message).to eq('Authentication credentials were not provided.')
+        expect(response.error.type).to eq('invalid_request_error')
       end
     end
   end

data/spec/filepreviews/http_spec.rb

@@ -22,22 +22,28 @@ describe Filepreviews::HTTP do
   end
 
   describe 'configure_api_auth_header' do
-    before(:each) { Filepreviews.api_key = nil }
+    before(:each) do
+      Filepreviews.api_key = nil
+      Filepreviews.secret_key = nil
+    end
+
     header = {
       'User-Agent'  => "Filepreviews-Rubygem/#{Filepreviews::VERSION}",
       'Content-Type' => 'application/json'
     }
 
     context 'when api_key is set' do
-      it 'configures the X-API-KEY header' do
+      it 'configures the Authorization header' do
         Filepreviews.api_key = '666'
-        expect(http.default_connection.headers['X-API-KEY']).to eq('666')
+        Filepreviews.secret_key = '000'
+        expect(http.default_connection.headers['Authorization'])
+          .to eq(Filepreviews::HTTP.generate_auth_key)
       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
+      it 'does not add the Authorization header' do
+        expect(http.default_connection.headers['Authorization']).to be_nil
         expect(http.default_connection.headers).to eq(header)
       end
     end

data/spec/filepreviews/utils_spec.rb

@@ -24,4 +24,26 @@ describe Filepreviews::Utils do
       expect(Kawaii.new.extract_size(size)).to eq('320x240')
     end
   end
+
+  describe '.validate_pages' do
+    context 'when called with range parameters (1-3)' do
+      it 'validates page parameters' do
+        expect(Kawaii.new.validate_pages('1-3'))
+          .to eq('1-3')
+      end
+    end
+
+    context 'when called with specific pages' do
+      it 'validates page parameters' do
+        expect(Kawaii.new.validate_pages('1,3,5'))
+          .to eq('1,3,5')
+      end
+    end
+
+    context 'when called with specific pages' do
+      it 'validates page parameters' do
+        expect(Kawaii.new.validate_pages('all')).to eq('all')
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filepreviews
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonah Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler