thumbor_rails 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822e16c0f961cec7b2f5b8baaa17fcd253eced25
-  data.tar.gz: 8f156ec653e4e8a69c4be64089ff03caa9f17ee0
+  metadata.gz: 5f945ed803b05c9cd5c033721e72c3e5a948ef03
+  data.tar.gz: 98812b81213e952bbd2afa9fe7c7b7e5965b7789
 SHA512:
-  metadata.gz: faef58844a6ef0c4df25f59439ab60d5ae84c2e005c954f3a231929c127d664dd3b141e0d0f0ccf877326c12613c2211a8c39cc138b93e9f6735899ecfa5f97c
-  data.tar.gz: 82562544d5ce6e35752e8e4a89644b6cc8a8189cf06bf853c77be0ecf7bd2b225ec0674b7a9caca526d47f42a6fe31e7db98c343af8bc772e56bb62bdfba53e1
+  metadata.gz: 3bef58317da733d42ce7271e8340e0570408d984580cbb09cc585cf90c7c9b6cad26709c638b7b218240aa0c00daf19e7ec02fbe1dcf57dad512046ad314a381
+  data.tar.gz: 44a48b1e8734047f3f2a2dedae7f5bb5b328a3335a46cf11ccf70a274e5bd9880ee3aff486cef5126ff00f28a73d8359fe8c4c2c52a95a23c8ccaa0a1a4da2b0

data/README.md

@@ -0,0 +1,74 @@
+# Thumbor Rails [<img src="https://secure.travis-ci.org/rafaelcaricio/thumbor_rails.png?branch=master" alt="Build Status" />](https://travis-ci.org/rafaelcaricio/thumbor_rails)
+
+https://github.com/rafaelcaricio/thumbor_rails
+
+## DESCRIPTION
+
+thumbor_rails is a client to make easier to use the thumbor imaging service (http://github.com/globocom/thumbor) in Ruby and Rails projects.
+
+## Installation
+
+You can use this gem by putting the following inside your Gemfile:
+
+```
+gem "thumbor_rails", "0.1.0"
+```
+
+Now generate the thumbor basic client configuration:
+
+```
+rails g thumbor_rails:install
+```
+
+It will generate the basic configuration in `config/initializers/thumbor_rails.rb` and you have to update the values of `server_url` to point to your thumbor server and the `security_key` to have your security key.
+
+That's all.
+
+## Usage
+
+There are two basic helpers you can use in your views:
+
+```
+thumbor_url
+thumbor_image_tag
+```
+
+### thumbor_url
+
+The `thumbor_url` helper allows you to to generate a thumbor url, a simple use is:
+
+```ruby
+<%= thumbor_url "http://example.com/awesome_image.jpg" %>
+```
+
+Of course, you can pass various parameters to thumbor as described in the [ruby-thumbor gem](https://github.com/thumbor/ruby-thumbor#usage). An exemple would be:
+
+```ruby
+<%= thumbor_url "http://example.com/awesome_image.jpg", width: 200, height: 300 %>
+```
+
+### thumbor_image_tag
+
+The `thumbor_image_tag` helper allows you to simplify the usage when creating a simple image tag in your views. It returns a complete image tag with the generated thumbor url in the `src` attribute of the `img` tag. Example:
+
+```ruby
+<%= thumbor_image_tag "http://myimage.jpg", unsafe: true, width: 100, height: 100 %>
+```
+
+Will result in something like:
+
+```html
+<img alt="Myimage" src="http://thumbor.example.com/unsafe/100x100/http://myimage.jpg" />
+```
+
+## Maintainers
+
+- Rafael Caricio (@rafaelcaricio)[https://coderwall.com/rafaelcaricio]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/generators/thumbor_rails/install_generator.rb

@@ -0,0 +1,12 @@
+module ThumborRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy ThumborRails default configuration files"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template "config/initializers/thumbor_rails.rb"
+      end
+    end
+  end
+end

data/lib/generators/thumbor_rails/templates/config/initializers/thumbor_rails.rb

@@ -0,0 +1,4 @@
+ThumborRails.setup do |config|
+  config.server_url = 'http://thumbor.example.com'
+  config.security_key = 'MY_SECURITY_KEY'
+end

data/lib/thumbor_rails/helpers.rb

@@ -0,0 +1,30 @@
+require 'ruby-thumbor'
+
+module ThumborRails
+  module Helpers
+    include ActionView::Helpers::AssetTagHelper
+
+    def thumbor_url(image_url, options = {})
+      options[:image] = image_url
+      thumbor_service = crypto_service
+      thumbor_service = unsafe_service if options[:unsafe]
+      "#{ThumborRails.server_url}#{thumbor_service.generate(options)}"
+    end
+
+    def thumbor_image_tag(image_url, options = {}, tag_attrs = {})
+      image_tag(thumbor_url(image_url, options), tag_attrs)
+    end
+
+    private
+
+    def crypto_service
+      Thumbor::CryptoURL.new(ThumborRails.security_key)
+    end
+
+    def unsafe_service
+      Thumbor::CryptoURL.new(nil)
+    end
+  end
+end
+
+ActionView::Base.send :include, ThumborRails::Helpers

data/lib/thumbor_rails/version.rb

@@ -1,3 +1,3 @@
 module ThumborRails
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/thumbor_rails.rb

@@ -1,7 +1,13 @@
+require 'thumbor_rails/helpers'
+
 module ThumborRails
-  class Yo
-    def hey!
-      puts "ho!"
-    end
+  mattr_accessor :server_url
+  @@server_url = 'http://thumbor.example.com'
+
+  mattr_accessor :security_key
+  @@security_key = 'MY_SECURITY_KEY'
+
+  def self.setup
+    yield self
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'action_view'
+require 'thumbor_rails'

data/spec/thumbor_rails/helpers_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ThumborRails::Helpers do
+  include ThumborRails::Helpers
+
+  describe "#thumbor_url" do
+    it 'should generate a basic encrypted url' do
+      expect(thumbor_url('http://test.img')).to eq('http://thumbor.example.com/yPVDsGJsQKjKky_cdbkNuIpc9-A=/http://test.img')
+    end
+
+    it 'should allow unsafe urls' do
+      expect(thumbor_url('http://test.img', unsafe: true)).to eq('http://thumbor.example.com/unsafe/http://test.img')
+    end
+
+    it 'should pass arguments to thumbor' do
+      expect(thumbor_url('http://test.img', unsafe: true, width: 100, height: 200)).to eq('http://thumbor.example.com/unsafe/100x200/http://test.img')
+    end
+  end
+
+  describe '#thumbor_image_tag' do
+    it 'should return a simple image' do
+      expect(thumbor_image_tag('http://myimg.jpg')).to eq('<img alt="Myimg" src="http://thumbor.example.com/Q-1lWnxlCLnkzXWWM5xTAs1QEBM=/http://myimg.jpg" />')
+    end
+
+    it 'should pass arguments to thumbor' do
+      expect(thumbor_image_tag('http://myimg.jpg', unsafe: true)).to eq('<img alt="Myimg" src="http://thumbor.example.com/unsafe/http://myimg.jpg" />')
+    end
+  end
+end

data/spec/thumbor_rails_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ThumborRails do
+  it 'setup block yields self' do
+    subject.setup do |config|
+      expect(subject).to equal(config)
+    end
+  end
+
+  it 'has security_key attibute' do
+    expect(subject).to respond_to 'security_key'
+  end
+
+  it 'has server_url attibute' do
+    expect(subject).to respond_to 'server_url'
+  end
+
+  describe 'when configured' do
+    before do
+      subject.setup do |config|
+        config.server_url = 'http://thumbor.globo.com'
+      end
+    end
+
+    it 'should use the configuration' do
+      expect(subject.server_url).to eq('http://thumbor.globo.com')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thumbor_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Rafael Caricio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-thumbor
@@ -67,16 +67,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: thumbor_rails is a client for the thumbor imaging service (http://github.com/globocom/thumbor)
-  in Ruby and Rails projects.
+  for Ruby and Rails projects.
 email:
 - rafael@caricio.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/thumbor_rails/install_generator.rb
+- lib/generators/thumbor_rails/templates/config/initializers/thumbor_rails.rb
+- lib/thumbor_rails/helpers.rb
 - lib/thumbor_rails/version.rb
 - lib/thumbor_rails.rb
-- README.rdoc
+- README.md
+- spec/spec_helper.rb
+- spec/thumbor_rails/helpers_spec.rb
+- spec/thumbor_rails_spec.rb
 homepage: https://github.com/rafaelcaricio/thumbor_rails
 licenses:
 - MIT
@@ -84,7 +90,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -103,5 +109,8 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: thumbor_rails is a client to manage and generate urls for the thumbor imaging
-  service (http://github.com/globocom/thumbor) in Ruby and Rails projects.
-test_files: []
+  service (http://github.com/globocom/thumbor) for Ruby and Rails projects.
+test_files:
+- spec/spec_helper.rb
+- spec/thumbor_rails/helpers_spec.rb
+- spec/thumbor_rails_spec.rb