cloudimage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38b6b4cf631917e41ac56722f43b942e77714815d52ac15a7080e56173d776e5
+  data.tar.gz: 8b5d8d15e125b076908c6d9a9e36cffe13dce4c89b2b7586235ccbc0c4e8dd71
+SHA512:
+  metadata.gz: 4405e0f5eacfd9417fc300b801cafac50a1a9e352c64bf7e611e401e66d6ac6cde6743c9a00db116118f2ae8eb2433cc5dba99fe695bc3705b0dd96911db4589
+  data.tar.gz: 28126cfc5f7c63153a6ef57b0b1bad2bd93cd22d14b093f68fa340ab2a65d730d3d25f84b3d3bedf676cca92547f0bd6bf579f5d3b55807755f899e9e273f9aa

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## master
+
+## 0.1.0 (2020-08-09)
+
+- Introduce base models: `Cloudimage::Client`, and `Cloudimage::URI`. Generate
+  URLs via `to_url` method. Add support for image resizing params.
+  [#2](https://github.com/scaleflex/cloudimage-rb/pull/2) (@janklimo)
+
+- Set up Github actions for CI.
+  [#1](https://github.com/scaleflex/cloudimage-rb/pull/1) (@janklimo)

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Scaleflex
+
+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,134 @@
+# cloudimage
+
+![](https://github.com/scaleflex/cloudimage-rb/workflows/Build/badge.svg)
+
+`cloudimage` is the official Ruby API wrapper for
+[Cloudimage's API](https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/introduction).
+
+Supports Ruby `2.4` and above, `JRuby`, and `TruffleRuby`.
+
+- [cloudimage](#cloudimage)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Hash of params](#hash-of-params)
+    - [Chainable helpers](#chainable-helpers)
+    - [Aliases](#aliases)
+    - [Custom helpers](#custom-helpers)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cloudimage'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cloudimage
+
+## Usage
+
+The only requirement to get started is your customer token. You can
+find it within your Admin interface:
+
+![token](docs/token.png)
+
+In order to interact with Cloudimage, we'll first initialize a client service
+object:
+
+```ruby
+client = Cloudimage::Client.new(token: 'mysecrettoken')
+```
+
+Calling `path` on the client object returns an instance of `Cloudimage::URI`.
+It accepts path to the image as a string and we we will use it to build
+Cloudimage URLs.
+
+```ruby
+uri = client.path('/assets/image.png')
+```
+
+Here are some common approaches for constructing Cloudimage URLs using this gem:
+
+### Hash of params
+
+Pass a hash to `to_url`. Every key becomes a param in the final Cloudimage
+URL so this gives you the freedom to pass arbitrary params if need be.
+
+```ruby
+uri.to_url(w: 200, h: 400, sharp: 1, gravity: 'west', ci_info: 1)
+# => "https://mysecrettoken.cloudimg.io/v7/assets/image.png?ci_info=1&gravity=west&h=400&sharp=1&w=200"
+```
+
+### Chainable helpers
+
+Every param supported by Cloudimage can be used as a helper method.
+
+```ruby
+uri.w(200).h(400).gravity('west').to_url
+# => "https://mysecrettoken.cloudimg.io/v7/assets/image.png?gravity=west&h=400&w=200"
+```
+
+While every key passed into `to_url` method gets appended to the URL,
+chainable helper methods will throw a `NoMethodError` when using an
+unsupported method.
+
+```ruby
+uri.heigth(200).to_url
+# NoMethodError (undefined method `heigth' for #<Cloudimage::URI:0x00007fae461c42a0>)
+```
+
+This is useful for catching typos and identifying deprecated methods in
+case Cloudimage's API changes.
+
+### Aliases
+
+The gem comes with a handful of useful aliases. Consult
+[`Cloudimage::Params`](lib/cloudimage/params.rb) module for their full list.
+
+```ruby
+uri.debug.prevent_enlargement.to_url
+# => "https://mysecrettoken.cloudimg.io/v7/assets/image.png?ci_info=1&org_if_sml=1"
+```
+
+From the example above you can see that params that only serve as a flag don't
+need to accept arguments and will be translated into `param=1` in the final URL.
+
+### Custom helpers
+
+For a list of custom helpers available to you, please consult
+[`Cloudimage::CustomHelpers`](lib/cloudimage/custom_helpers.rb) module.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended
+to be a safe, welcoming space for collaboration, and contributors
+are expected to adhere to the
+[code of conduct](https://github.com/scaleflex/cloudimage-rb/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting with the project's codebase, issues, and pull
+requests is expected to follow the
+[code of conduct](https://github.com/scaleflex/cloudimage-rb/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cloudimage'
+require 'irb'
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/cloudimage.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'addressable/uri'
+
+require_relative 'cloudimage/version'
+require_relative 'cloudimage/client'

data/lib/cloudimage/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'uri'
+
+module Cloudimage
+  class InvalidConfig < StandardError; end
+
+  class Client
+    attr_reader :token
+
+    API_VERSION = 'v7'
+
+    def initialize(token: nil)
+      @token = token
+
+      ensure_valid_config
+    end
+
+    def path(path)
+      URI.new(base_url_for(token), path)
+    end
+
+    private
+
+    def base_url_for(token)
+      "https://#{token}.cloudimg.io/#{API_VERSION}"
+    end
+
+    def ensure_valid_config
+      return unless token.to_s.strip.empty?
+
+      raise InvalidConfig, 'Please specify your Cloudimage customer token.'
+    end
+  end
+end

data/lib/cloudimage/custom_helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cloudimage
+  module CustomHelpers
+    def positionable_crop(origin_x:, origin_y:, width:, height:)
+      tl_px(origin_x, origin_y).br_px(origin_x + width, origin_y + height)
+    end
+  end
+end

data/lib/cloudimage/params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Cloudimage
+  module Params
+    ALIASES = {
+      debug: :ci_info,
+      prevent_enlargement: :org_if_sml,
+      rotate: :r,
+      sharper_resizing: :sharp,
+      resize_mode: :func,
+    }.freeze
+
+    PARAMS = %i[
+      bg_blur
+      bg_color
+      bg_colorize
+      bg_colour
+      bg_colourise
+      bg_img_fit
+      bg_opacity
+      br_px
+      ci_info
+      func
+      gravity
+      h
+      height
+      org_if_sml
+      r
+      sharp
+      tl_px
+      trim
+      w
+      width
+    ].freeze
+  end
+end

data/lib/cloudimage/uri.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'params'
+require_relative 'custom_helpers'
+
+module Cloudimage
+  class URI
+    include Params
+    include CustomHelpers
+
+    attr_reader :uri, :params
+
+    def initialize(base_url, path)
+      path = ensure_path_format(path)
+      @uri = Addressable::URI.parse(base_url + path)
+      @params = {}
+    end
+
+    PARAMS.each do |param|
+      define_method param do |*args|
+        @params[param] = if args.any?
+                           args.join(',')
+                         else
+                           # Flag params don't need to pass in arguments.
+                           @params[param] = 1
+                         end
+        self
+      end
+    end
+
+    ALIASES.each do |from, to|
+      alias_method from, to
+    end
+
+    def to_url(extra_params = {})
+      url_params = params.merge(extra_params)
+      uri.query_values = url_params if url_params.any?
+      uri.to_s
+    end
+
+    private
+
+    def ensure_path_format(path)
+      path.start_with?('/') ? path : "/#{path}"
+    end
+  end
+end

data/lib/cloudimage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cloudimage
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: cloudimage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Klimo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Fast and easy image resizing, transformation, and acceleration in the
+  Cloud.
+email:
+- jan.klimo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/cloudimage.rb
+- lib/cloudimage/client.rb
+- lib/cloudimage/custom_helpers.rb
+- lib/cloudimage/params.rb
+- lib/cloudimage/uri.rb
+- lib/cloudimage/version.rb
+homepage: https://github.com/scaleflex/cloudimage-rb
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/scaleflex/cloudimage-rb/issues
+  changelog_uri: https://github.com/scaleflex/cloudimage-rb/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/scaleflex/cloudimage-rb
+  documentation_uri: https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/introduction
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Official API wrapper for Cloudimage's API.
+test_files: []