image_flux 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 986f54bd3b8b9403395fdef47c91f007b70b959e
+  data.tar.gz: 96994e08bb172eb651c02f89b138e8078be36aef
+SHA512:
+  metadata.gz: 9ee0566b415768c7788d47e3282c9b14b65440bf4ef5508e2891820a293258dbd876e57dd409e93359c3d7bc78935c00aac8b4c621e166ca916dee5aedd70fb2
+  data.tar.gz: 182408c61948d5c92e5e4b0004d15194b21e103d37efaad910b206251489f8e55a9fb3da45f6333a8a86a723cda9c4d417918e84b17b9eb71cd22656accdb422

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.4.1
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: Update Bunndler
+          command: gem update bundler
+
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "image_flux.gemspec" }}
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "image_flux.gemspec" }}
+
+      - run:
+          name: RSpec
+          command: |
+            mkdir /tmp/test-results
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,82 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - config/application.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+  Enabled: true
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+#################### Metrics ###############################
+
+Metrics/AbcSize:
+  Max: 15
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  ExcludedMethods: []
+  Exclude:
+    - Guardfile
+
+Metrics/BlockNesting:
+  CountBlocks: false
+  Max: 3
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/LineLength:
+  Max: 180
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ParameterLists:
+  Max: 5
+
+Metrics/PerceivedComplexity:
+  Max: 7
+
+#################### Lint ##################################
+
+Lint/UnusedBlockArgument:
+  IgnoreEmptyBlocks: true
+  AllowUnusedKeywordArguments: true
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+  IgnoreEmptyMethods: true
+
+#################### Performance ###########################
+
+Performance/DoubleStartEndWith:
+  IncludeActiveSupportAliases: false
+
+Performance/RedundantMerge:
+  MaxKeyValuePairs: 2
+
+#################### Rails #################################
+
+Rails/ActionFilter:
+  EnforcedStyle: action

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in image_flux.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sho Kusano
+
+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,56 @@
+# ImageFlux
+
+[![Gem](https://img.shields.io/gem/v/image_flux.svg)](https://rubygems.org/gems/image_flux)
+[![CircleCI](https://img.shields.io/circleci/project/github/space-pirates-llc/image_flux.svg)](https://circleci.com/gh/space-pirates-llc/image_flux)
+[![Coverage Status](https://coveralls.io/repos/github/space-pirates-llc/image_flux/badge.svg?branch=master)](https://coveralls.io/github/space-pirates-llc/image_flux?branch=master)
+
+URL builder for [ImageFlux](https://www.sakura.ad.jp/services/imageflux/)®.
+
+WIP: Provide API client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'image_flux'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install image_flux
+
+## Usage
+
+### Generate resize url for a path
+
+```ruby
+require 'image_flux'
+origin = ImageFlux::Origin.new(domain: 'example.imageflux.jp')
+
+origin.image_url("/original.jpg', width: 100)
+# => https://example.imageflux.jp/c/w=100/original.jpg
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/space-pirates-llc/image_flux>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Notation
+
+- ImageFlux is a registered trademark of [SAKURA Internet Inc](https://www.sakura.ad.jp/).
+- Regarding the use of this gem, pixiv Inc and SAKURA Internet Inc makes no responsibility.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'image_flux'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/image_flux.gemspec

@@ -0,0 +1,33 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'image_flux/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'image_flux'
+  spec.version       = ImageFlux::VERSION
+  spec.authors       = ['Sho Kusano']
+  spec.email         = ['sho-kusano@space-pirates.jp']
+
+  spec.summary       = 'URL builder for ImageFlux'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/space-pirates-llc/image_flux'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'ffaker'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+end

data/lib/image_flux.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'image_flux/version'
+require 'image_flux/origin'
+require 'image_flux/option'
+
+module ImageFlux
+  class << self
+    attr_accessor :default_origin
+
+    def image_url(path, options = {})
+      default_origin.image_url(path, options)
+    end
+  end
+end

data/lib/image_flux/attribute.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'image_flux'
+
+class ImageFlux::Attribute
+  def initialize(name, type, default: nil, aliases: [], enum: nil, query: true)
+    @name = name.to_s.to_sym
+    @type = type
+    @default = default
+    @aliases = aliases.flatten.map { |a| a.to_s.to_sym }.uniq
+    @enum = enum
+    @validators = []
+    @query = query
+  end
+  attr_reader :name, :type, :default, :aliases
+
+  def validate(&block)
+    @validators.push(block)
+  end
+
+  def expand(value)
+    @enum ? @enum.fetch(value) { value } : value
+  end
+
+  def querize(value, ignore_default: true)
+    value = expand(value)
+    return nil if !@query || (ignore_default && default == value)
+
+    value = case type
+            when :string
+              ERB::Util.url_encode(value.to_s)
+            when :integer
+              value.to_i.to_s
+            when :float
+              value.to_f.to_s
+            when :integer_array
+              value.map(&:to_i).join(':')
+            when :float_array
+              value.map(&:to_f).join(':')
+            when :boolean
+              value ? '1' : '0'
+            else
+              value
+            end
+
+    "#{name}=#{value}"
+  end
+
+  def validate!(value)
+    errors = []
+    value = expand(value)
+    errors.push(validate_type(value))
+    @validators.each do |validator|
+      errors.push(validator.call(value))
+    end
+    errors.reject(&:nil?)
+  end
+
+  def validate_type(value)
+    check = case type
+            when :string
+              value.is_a?(String) || value.respond_to?(:to_s)
+            when :integer
+              value.is_a?(Integer) || value.respond_to?(:to_i)
+            when :float
+              value.is_a?(Float) || value.respond_to?(:to_f)
+            when :integer_array
+              value.is_a?(Array) && value.all? { |elem| elem.is_a?(Integer) || elem.respond_to?(:to_i) }
+            when :float_array
+              value.is_a?(Array) && value.all? { |elem| elem.is_a?(Float) || elem.respond_to?(:to_i) }
+            when :boolean
+              value.is_a?(TrueClass) || value.is_a?(FalseClass)
+            else
+              true
+            end
+
+    return "#{name} is invalid type(expected be a #{type})" unless check
+  end
+end

data/lib/image_flux/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'image_flux'
+
+class ImageFlux::Error < StandardError
+end
+
+class ImageFlux::InvalidOptionError < ImageFlux::Error
+end

data/lib/image_flux/option.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'image_flux'
+require 'image_flux/attribute'
+require 'image_flux/error'
+
+class ImageFlux::Option
+  def self.attributes
+    @attributes ||= []
+  end
+
+  def self.key_pairs
+    @key_pairs ||= {}
+  end
+
+  def self.attribute(name, type, options = {}, &block)
+    attribute = ImageFlux::Attribute.new(name, type, options)
+    attribute.instance_eval(&block) if block_given?
+    key_pairs[attribute.name] = attribute
+    attribute.aliases.each do |key|
+      key_pairs[key] = attribute
+    end
+
+    attributes.push(attribute)
+  end
+
+  # Predefined prefix path
+  attribute :prefix, :string, default: nil, query: false
+
+  # resize attributes
+  attribute :w, :integer, default: nil, aliases: %i[width]
+  attribute :h, :integer, default: nil, aliases: %i[height]
+  attribute :u, :boolean, default: true, aliases: %i[upscale]
+  attribute :a, :integer, default: 1, aliases: %i[aspect]
+  attribute :c, :integer_array, default: nil, aliases: %i[crop]
+  attribute :cr, :float_array, default: nil, aliases: %i[]
+  attribute :g, :integer, default: 4, aliases: %i[gravity], enum: {
+    top_left: 1,
+    top_center: 2,
+    top_right: 3,
+    middle_left: 4,
+    middle_center: 5,
+    middle_right: 6,
+    bottom_left: 7,
+    bottom_center: 8,
+    bottom_right: 9
+  }
+  attribute :b, :string, default: 'ffffff', aliases: %i[background] do
+    validate do |value|
+      'b should be a color code' unless value.to_s =~ %r{\A[0-9a-fA-F]{6}\z}
+    end
+  end
+  attribute :r, :integer, default: 1, aliases: %i[rotate]
+  # overlay attributes
+  attribute :l, :string, default: nil
+  attribute :lx, :integer, default: nil
+  attribute :lxr, :integer, default: nil
+  attribute :ly, :integer, default: nil
+  attribute :lyr, :integer, default: nil
+  attribute :lg, :integer, default: 5, aliases: %i[gravity], enum: {
+    top_left: 1,
+    top_center: 2,
+    top_right: 3,
+    middle_left: 4,
+    middle_center: 5,
+    middle_right: 6,
+    bottom_left: 7,
+    bottom_center: 8,
+    bottom_right: 9
+  }
+  # output attributes
+  attribute :f, :string, default: 'auto', aliases: %i[format] do
+    validate do |value|
+      %w[auto jpg png gif webp:jpeg webp:png].include?(value.to_s)
+    end
+  end
+  attribute :q, :integer, default: 75, aliases: %i[quality]
+  attribute :o, :boolean, default: true, aliases: %i[optimize]
+
+  attribute :sig, :nonescape_string, default: nil
+
+  def initialize(options = {})
+    @values = {}
+
+    options.each_pair do |key, val|
+      key = key.to_s.to_sym
+      attribute = self.class.key_pairs[key]
+      @values[attribute] = val if attribute
+    end
+  end
+
+  def prefix_path
+    prefix_attr = self.class.key_pairs[:prefix]
+    @values[prefix_attr]
+  end
+
+  def to_query(ignore_default: true)
+    errors = []
+    queries = @values.to_a.map do |pair|
+      attribute = pair.first
+      value = pair.last
+      errors.concat(attribute.validate!(value))
+      attribute.querize(value)
+    end
+    raise ImageFlux::InvalidOptionError, errors.join(', ') unless errors.length.zero?
+
+    queries.reject(&:nil?).join(',')
+  end
+end

data/lib/image_flux/origin.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'openssl'
+require 'base64'
+require 'image_flux'
+
+class ImageFlux::Origin
+  attr_reader :domain, :scheme, :signing_version, :signing_secret
+  def initialize(domain:, scheme: 'https', signing_version: '1', signing_secret: nil, **_options)
+    @domain = domain.to_s
+    @scheme = scheme.to_s
+    @signing_version = signing_version
+    @signing_secret = signing_secret
+  end
+
+  def base_url
+    @base_url ||= URI("#{@scheme}://#{@domain}/")
+  end
+
+  def image_url(path, options = {})
+    path = "/#{path}" unless path.start_with?('/')
+
+    options = options.merge(sig: sign(path)) if @signing_secret
+    opt = ImageFlux::Option.new(options)
+
+    path = "#{opt.prefix_path}#{path}" if opt.prefix_path
+    query = opt.to_query
+
+    url = base_url.dup
+    url.path = query.length.zero? ? path : "/c/#{opt.to_query}#{path}"
+
+    url
+  end
+
+  def sign(path)
+    digest = OpenSSL::HMAC.digest('sha256', @signing_secret, path)
+
+    "#{@signing_version}.#{Base64.urlsafe_encode64(digest)}"
+  end
+end

data/lib/image_flux/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ImageFlux
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: image_flux
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sho Kusano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: URL builder for ImageFlux
+email:
+- sho-kusano@space-pirates.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- image_flux.gemspec
+- lib/image_flux.rb
+- lib/image_flux/attribute.rb
+- lib/image_flux/error.rb
+- lib/image_flux/option.rb
+- lib/image_flux/origin.rb
+- lib/image_flux/version.rb
+homepage: https://github.com/space-pirates-llc/image_flux
+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.6.13
+signing_key: 
+specification_version: 4
+summary: URL builder for ImageFlux
+test_files: []