imageboss-rails 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d05888e20d6047a9dd79f40f544ff87c3e27fbc
+  data.tar.gz: a24f3d72df1ddb7caa346b32db7a7e0f532ed0fd
+SHA512:
+  metadata.gz: 2afa504604727ea5664085039dbd8ea59d3c8ea41c3c21ecd9683e3577ec5d9ea055204199f441896a7a066b4870e5afa480577fa41cdc81fcd6b109cb696839
+  data.tar.gz: 571c0b6995f0f1220817f779fff2a19d8f946885965727fdfa4033ac78eab63d5612665a14f42896067d91971f2a58ca93697bd3705f29e7b8720467c4dd6926

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Igor Escobar
+
+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,127 @@
+[![ImageBoss logo](https://service.imageboss.me/width/180/https://imageboss.me/emails/logo-2@2x.png)](https://imageboss.me)
+
+# ImageBoss Helper for Ruby On Rails
+[![Build Status](https://travis-ci.org/imageboss/imageboss-rails.svg?branch=master)](https://travis-ci.org/imageboss/imageboss-rails) [![Gem Version](https://badge.fury.io/rb/imageboss-rails.svg)](https://badge.fury.io/rb/imageboss-rails)
+
+Official Gem for generating ImageBoss URLs with Ruby On Rails. It's built on top of [imageboss-rb](https://github.com/imageboss/imageboss-rails)
+to offer rails specific features.
+
+[ImageBoss](https://imageboss.me/) is a service designed to handle on-demand image processing with content aware recognition, progressive scans, compression, CDN and more.
+
+We recommend using something like [Paperclip](https://github.com/thoughtbot/paperclip), [Refile](https://github.com/refile/refile), [Carrierwave](https://github.com/carrierwaveuploader/carrierwave), or [s3_direct_upload](https://github.com/waynehoover/s3_direct_upload) to handle uploads and make them available. After they've been uploaded, you can then serve them using this gem or you can't disable ImageBoss for spacific environments. Read on.
+
+**Table of Contents**
+- [ImageBoss Helper for Ruby On Rails](#imageboss-helper-for-ruby-on-rails)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Configuration](#configuration)
+      - [Same configuration across all environemnts](#same-configuration-across-all-environemnts)
+    - [imageboss_tag](#imageboss_tag)
+    - [Native Rails image_tag options](#native-rails-image_tag-options)
+    - [imageboss_url](#imageboss_url)
+    - [Usage in Sprockets](#usage-in-sprockets)
+    - [Disable ImageBoss URL on specific environments](#disable-imageboss-url-on-specific-environments)
+  - [Compatibility](#compatibility)
+
+## Installation
+Just run the following:
+```bash
+$ bundle add imageboss-rails
+```
+
+Or install it yourself as:
+```bash
+$ gem install imageboss-rails
+```
+
+## Usage
+`imageboss-rails` provide you a few helpers to make the integration easier. To know all operations and options available please read the [ImageBoss Docs](https://imageboss.me/docs).
+
+### Configuration
+#### Same configuration across all environemnts
+Just add the following to `app/config/application.rb`:
+
+```ruby
+Rails.application.configure do
+  config.imageboss.source = "https://assets.mywebsite.com"
+end
+```
+
+### imageboss_tag
+Just like the Rails' [image_tag](https://apidock.com/rails/ActionView/Helpers/AssetTagHelper/image_tag) it will generate an `<img>` tag for you - but wrapped by the ImageBoss gem adding some more functionalities. The syntax is the following:
+```ruby
+<%= imageboss_tag('my-nice-image', :cover, { width: 100, height: 100 }) %>
+```
+Will output the following:
+```html
+<img
+  alt="my-nice-image"
+  src="https://service.imageboss.me/cover/100x100/https://assets.mywebsite.com/assets/my-nice-image.jpg"
+/>
+```
+
+### Native Rails image_tag options
+If you want to provide native `image_url` helper options just add them to the end of the helper:
+```ruby
+<%= imageboss_tag('my-nice-image', :cover, { width: 100, height: 100 }, alt: "Sunny Lisbon!") %>
+```
+Will output the following:
+```html
+<img
+  alt="Sunny Lisbon!"
+  src="https://service.imageboss.me/cover/100x100/https://assets.mywebsite.com/assets/my-nice-image.jpg"
+/>
+```
+
+### imageboss_url
+Just like Rails' [asset_url](https://apidock.com/rails/ActionView/Helpers/AssetUrlHelper/asset_url) but it will output your `path` with a fully valid ImageBoss URL.
+```ruby
+<%= imageboss_url('my-nice-image', :width, { width: 100 }) %>
+```
+Will output the following:
+```
+https://service.imageboss.me/width/100/https://assets.mywebsite.com/assets/my-nice-image.jpg
+```
+
+### Usage in Sprockets
+
+`imageboss_url` is also pulled in as a Sprockets helper, so you can generate ImageBoss URLs in your asset pipeline files. For example, here's how it would work inside an `.scss.erb` file:
+
+```scss
+.user-profile {
+  background-image: url(<%= imageboss_url('a-nice-profile.svg', :cover, { width: 400, height: 300 }) %>);
+}
+```
+
+### Disable ImageBoss URL on specific environments
+If on `development` or `test` environment you are not sending images to the cloud you can disable the generation of ImageBoss URLs for thos environment. For example, if you want to disable on `development`, just add the following to your `config/environments/development.rb` file.
+
+```ruby
+config.imageboss.enabled = false
+```
+With this configured in all places you call `imageboss_url` or `imageboss_tag` the `src` or the `url` generated will fallback straight to your localhost images. For example instead of generating this URL:
+```
+https://service.imageboss.me/cover/100x100/https://assets.mywebsite.com/assets/my-nice-image.jpg
+```
+it will output this:
+```
+http://localhost:3000/assets/my-nice-image.jpg
+```
+This is nice because you won't need to add any extra code to handle this yourself.
+
+## Compatibility
+Rails
+  - 5
+  - 4
+
+Ruby
+  - 2.4.x
+  - 2.3.x
+  - 2.2.x
+  - 2.1.x
+
+jRuby
+  - jruby-9.0.5.x
+
+Rubinius
+  - rbx-3.x

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task default: :test

data/lib/imageboss/rails/url_helper.rb

@@ -0,0 +1,24 @@
+module ImageBoss
+  module Rails
+    module UrlHelper
+      include ActionView::Helpers
+
+      def imageboss_url(path, operation, options)
+        imageboss_client
+          .path(image_path(path))
+          .operation(operation, options)
+          .html_safe
+      end
+
+      private
+
+      def imageboss_client
+        config = ::ImageBoss::Rails.config.imageboss || {}
+        client_options = {}
+        client_options[:domain] = config[:asset_host]
+        client_options[:enabled] = config[:enabled] unless config[:enabled].nil?
+        @imageboss_client = ::ImageBoss::Client.new(**client_options)
+      end
+    end
+  end
+end

data/lib/imageboss/rails/version.rb

@@ -0,0 +1,5 @@
+module ImageBoss
+  module Rails
+    VERSION = '1.0.2'
+  end
+end

data/lib/imageboss/rails/view_helper.rb

@@ -0,0 +1,13 @@
+module ImageBoss
+  module Rails
+    module ViewHelper
+      include ActionView::Helpers
+      include ImageBoss::Rails::UrlHelper
+
+      def imageboss_tag(path, operation, options, image_opts = {})
+        image_url = imageboss_url(asset_path(path), operation.to_sym, options)
+        image_tag(image_url, image_opts)
+      end
+    end
+  end
+end

data/lib/imageboss/rails.rb

@@ -0,0 +1,16 @@
+require 'imageboss'
+require 'imageboss/railtie' if defined? Rails::Railtie
+
+module ImageBoss
+  module Rails
+    class Config < ::ActiveSupport::OrderedOptions; end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.configure
+      yield config
+    end
+  end
+end

data/lib/imageboss/railtie.rb

@@ -0,0 +1,22 @@
+require 'rails'
+require 'rails/railtie'
+require 'imageboss/rails'
+require 'imageboss/rails/url_helper'
+require 'imageboss/rails/view_helper'
+
+module ImageBoss
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.imageboss = ActiveSupport::OrderedOptions.new
+
+      initializer 'imageboss-rails.view_helper' do |app|
+        ImageBoss::Rails.configure do |config|
+          config.imageboss = app.config.imageboss
+        end
+
+        ActionView::Base.send :include, ViewHelper
+        Sprockets::Context.send :include, UrlHelper if defined? Sprockets
+      end
+    end
+  end
+end

data/lib/tasks/imageboss/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :imageboss_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: imageboss-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Igor Escobar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: imageboss-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: Official Ruby On Rails gem for generating ImageBoss URLs
+email:
+- igor@imageboss.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/imageboss/rails.rb
+- lib/imageboss/rails/url_helper.rb
+- lib/imageboss/rails/version.rb
+- lib/imageboss/rails/view_helper.rb
+- lib/imageboss/railtie.rb
+- lib/tasks/imageboss/rails_tasks.rake
+homepage: https://imageboss.me
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generate ImageBoss URLs with Ruby on Rails
+test_files: []