imagga 0.0.3 → 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2ViMjRjNTFlZmE3YTNmYzc4ZTEwMjlmZDg5NjJiNzRkNGRjOGViNg==
+  data.tar.gz: !binary |-
+    NGMyOTRhMzEzMTkzZmQ5MjJmMTkxZGJiOTBiYzViM2IwZTE0Njk1Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDc1MWI4N2NmOGQ0N2FlZTQ2NjJjZDRkMzA0ZDhiYzAyNjcwMmNlNmI0OGY3
+    MjY2ZjVlOTcwMzhiZWRmMmI0N2YyYjU1MDQxYWU4MWI3YjM5ZjM2MzU2NjI4
+    MDAwNTQ5NGUxMDRmZWE4MmRjNTkzMGE2OTljZGIwM2ZiZWQ2MTg=
+  data.tar.gz: !binary |-
+    YTc1ODMzZGVlOTgyZDAwM2JlMmZiNjNiMzNlMWZkMWYyNDdmNGY2MGY4NTJh
+    MjE4ZDI2M2FiNzRhOTNmMWY0N2FjYTQ0YWJmNTFlMWQ0ZTNmNjY3YzMxZWNh
+    MzlhYTkwMmQ5NTgwZTJiZjRhNWUzNDBiNTRhZjZmM2U5YTJkNTM=

data/README.md

@@ -1,3 +1,4 @@
+[![Code Climate](https://codeclimate.com/github/martkaru/imagga.png)](https://codeclimate.com/github/martkaru/imagga)
 [![Build Status](https://travis-ci.org/martkaru/imagga.png?branch=master)](https://travis-ci.org/martkaru/imagga)
 
 # Imagga
@@ -56,7 +57,10 @@ Check the results, for example:
 Multi-color search:
 
     client.rank(
-      color_vector: '20,82,37,43,30,20,30,10',  # vector of colors (percentage, r, g, b)
+      colors: [
+        Imagga::RankColor.new(percent: 100, r: 82, g: 37, b: 43)   # use r g b values
+        Imagga::RankColor.new(percent: 100, hex: '#336699')        # or use hex
+      ],
       type: 'object',
       dist: 6000,
       count: 10
@@ -64,6 +68,29 @@ Multi-color search:
       puts "Distance of #%i is %.4f" % [similarity.id, similarity.dist]  # Distance of #333 is 3581.5500
     end
 
+Image crop suggestions:
+
+    client.crop(
+      [
+        'http://image1',                        # Use urls
+        Imagga::Image.new(url: 'http://image2') # or image object
+      ],
+      resolutions: ['100x40','50x100'],         # '100,40,50,100' or '100x40,50x100' instead of array would work also
+      no_scaling: true
+    ).each do |crop_info|
+      puts crop_info.url
+      crop_info.croppings.each do |cropping|
+        puts cropping.info
+      end
+    end
+
+## Contributors
+
+martkaru
+
+jprosevear
+
+
 ## Contributing
 
 1. Fork it

data/imagga.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "httparty", "~> 0.10"
   gem.add_dependency "json", "~> 1.7"
+  gem.add_dependency "color", "~> 1.4.1"
 
   gem.add_development_dependency "rspec", "~> 2.12"
   gem.add_development_dependency "rake"

data/lib/imagga.rb

@@ -1,7 +1,12 @@
 require "imagga/version"
 require "imagga/exceptions"
-require "imagga/extract_result_builder"
-require "imagga/rank_result_builder"
 require "imagga/image"
-require "imagga/extract_options"
+require "imagga/result_builder"
+require "imagga/parametizer"
+require "imagga/image_or_url_parametizer"
+require "imagga/rank_color_parametizer"
+require "imagga/resolution_parametizer"
+require "imagga/commands"
+require "imagga/core_client"
+require "imagga/options"
 require "imagga/client"

data/lib/imagga/client.rb

@@ -1,42 +1,20 @@
-require "httparty"
-require "json"
-
 module Imagga
-  class Client
-    include HTTParty
-    include Imagga::Exceptions
-    attr_reader :api_key, :api_secret, :base_uri, :service_path
-
-    def initialize(opts={})
-      @api_key     = opts[:api_key]    || raise_missing(:api_key)
-      @api_secret  = opts[:api_secret] || raise_missing(:api_secret)
-      @base_uri    = opts[:base_uri]   || raise_missing(:base_uri)
-      @service_path = '/colorsearchserver.php'
-
-      Imagga::Client.base_uri @base_uri
-    end
-
-    def extract(urls_or_images, additional_options={})
-      options = extract_options(urls_or_images, additional_options)
-      result = JSON.parse(self.class.post(service_path, body: options))
-      raise_if_request_failed!(result)
-      ExtractResultBuilder.new.build_from(result)
-    end
-
-    def rank(opts)
-      result = JSON.parse(self.class.post(service_path, body: rank_options(opts)))
-      raise_if_request_failed!(result)
-      RankResultBuilder.new.build_from(result)
+  class Client < CoreClient
+    def extract(urls_or_images, options={})
+      options.merge!(ImageOrUrlParametizer.new.parametrize(urls_or_images))
+      ExtractResultBuilder.new.build_from(super(options))
     end
 
-    private
-
-    def extract_options(urls_or_images, additional_options)
-      ExtractOptions.new(api_key, api_secret).options(urls_or_images, additional_options)
+    def rank(options={})
+      colors = options.delete(:colors) { raise_missing('colors') }
+      options.merge!(RankColorParametizer.new.parametrize(colors))
+      RankResultBuilder.new.build_from(super(options))
     end
 
-    def rank_options(opts)
-      RankOptions.new(api_key, api_secret).options(opts)
+    def crop(urls_or_images, options={})
+      options.merge!(ImageOrUrlParametizer.new.build_urls(urls_or_images))
+      options.merge!(ResolutionParametizer.new.parametrize(options.fetch(:resolutions)))
+      CropResultBuilder.new.build_from(super(options))
     end
   end
 end

data/lib/imagga/commands.rb

@@ -0,0 +1,42 @@
+require "httparty"
+require "json"
+
+module Imagga
+  class BaseCommand
+    include HTTParty
+    include Imagga::Exceptions
+
+    attr_reader :api_key, :api_secret, :base_uri
+
+    def initialize(api_key, api_secret, base_uri)
+      @api_key, @api_secret, @base_uri = api_key, api_secret, base_uri
+      self.class.base_uri @base_uri
+    end
+
+    def execute(options)
+      JSON.parse(self.class.post(service_path, body: args(options))).tap do |result|
+        raise_if_request_failed!(result)
+      end
+    end
+
+    def args(options)
+      options_class.new(api_key, api_secret).options(options)
+    end
+
+    def options_class; BaseOptions; end
+  end
+
+  class ExtractCommand < BaseCommand
+    def service_path; '/colorsearchserver.php'; end
+    def options_class; ExtractOptions; end
+  end
+
+  class RankCommand < ExtractCommand
+    def options_class; RankOptions; end
+  end
+
+  class CropCommand < BaseCommand
+    def service_path; '/extractionrestserver.php'; end
+    def options_class; CropOptions; end
+  end
+end

data/lib/imagga/core_client.rb

@@ -0,0 +1,25 @@
+module Imagga
+  class CoreClient
+    include Imagga::Exceptions
+    attr_reader :api_key, :api_secret, :base_uri
+
+    def initialize(opts={})
+      @api_key     = opts[:api_key]    || raise_missing(:api_key)
+      @api_secret  = opts[:api_secret] || raise_missing(:api_secret)
+      @base_uri    = opts[:base_uri]   || raise_missing(:base_uri)
+    end
+
+    def extract(options={})
+      ExtractCommand.new(api_key, api_secret, base_uri).execute(options)
+    end
+
+    def rank(options={})
+      RankCommand.new(api_key, api_secret, base_uri).execute(options)
+    end
+
+    def crop(options={})
+      CropCommand.new(api_key, api_secret, base_uri).execute(options)
+    end
+  end
+end
+

data/lib/imagga/exceptions.rb

@@ -1,5 +1,6 @@
 module Imagga
   module Exceptions
+
     def raise_missing(attribute)
       raise ArgumentError, "%s is missing" % attribute.to_s
     end
@@ -9,10 +10,12 @@ module Imagga
         raise Imagga::ClientException.new(result['error_code'].to_i), result['error_message'], caller[0..-1]
       end
     end
+
   end
 
   class ClientException < StandardError
     attr_accessor :error_code
+
     def initialize(error_code)
       @error_code = error_code
       super

data/lib/imagga/image.rb

@@ -1,11 +1,13 @@
+require 'color'
+
 module Imagga
   class Image
     include Imagga::Exceptions
     attr_accessor :url, :id
 
     def initialize(opts)
-      @url = opts[:url] || raise_missing(:url)
-      @id  = opts[:id]  || 0
+      @url             = opts[:url] || raise_missing(:url)
+      @id              = opts[:id]  || 0
     end
   end
 
@@ -64,6 +66,20 @@ module Imagga
     end
   end
 
+  class RankColor
+    attr_accessor :percent, :r, :g, :b, :hex
+    def initialize(opts)
+      @percent = opts.fetch(:percent)
+      if @hex = opts[:hex]
+        color = Color::RGB.from_html(@hex)
+        @r, @g, @b = color.red, color.green, color.blue
+      else
+        @r, @g, @b = opts[:r], opts[:g], opts[:b]
+        @hex = Color::RGB.new(r, g, b).html
+      end
+    end
+  end
+
   class RankSimilarity < ImageInfoBase
     def self.fields
       %w(id dist)
@@ -71,4 +87,45 @@ module Imagga
 
     attr_accessor *fields
   end
+
+  class CropInfo < ImageInfoBase
+    def self.fields
+      %w(url)
+    end
+
+    def self.crop_fields
+      %w(croppings)
+    end
+
+    def initialize(opts={})
+      super({'url' => opts['url']})
+      self.class.crop_fields.each do |field|
+        send("#{field}=", build_image_crops(opts[field]))
+      end
+    end
+
+    def build_image_crops(image_crop_nodes)
+      image_crop_nodes && image_crop_nodes.map { |crop_node| ImageCrop.new(crop_node) }
+    end
+
+    attr_accessor *(fields + crop_fields)
+  end
+
+  class ImageCrop < ImageInfoBase
+    def self.fields
+      %w(target_width target_height x1 y1 x2 y2)
+    end
+
+    attr_accessor *fields
+
+    %w(target_width target_height x1 y1 x2 y2).each do |field|
+      define_method("#{field}=") do |value|
+        instance_variable_set("@#{field}", value.to_i)
+      end
+    end
+
+    def info
+      "target: (%i,%i), crop: (%i, %i) to (%i, %i)" % [target_width, target_height, x1, y1, x2, y2]
+    end
+  end
 end

data/lib/imagga/image_or_url_parametizer.rb

@@ -0,0 +1,21 @@
+module Imagga
+  class ImageOrUrlParametizer
+    include Parametizer
+
+    def parametrize(urls_or_images)
+      options = build_urls(urls_or_images)
+      if (ids = build_ids(urls_or_images))[:ids]
+        options.merge!(ids)
+      end
+      options
+    end
+
+    def build_urls(urls_or_images)
+      { urls: [urls_or_images].flatten.map{ |o| o.url rescue o }.join(',') }
+    end
+
+    def build_ids(urls_or_images)
+      { ids: build_comma_separated_string(urls_or_images, :id, 0) }
+    end
+  end
+end

data/lib/imagga/options.rb

@@ -0,0 +1,74 @@
+module Imagga
+  class BaseOptions
+    include Parametizer
+    attr_accessor :api_key, :api_secret, :version
+
+    def initialize(api_key, api_secret)
+      @version    = '1.0'
+      @api_key    = api_key    || raise_missing(:api_key)
+      @api_secret = api_secret || raise_missing(:api_secret)
+    end
+
+    def base_options
+      { v: version, api_key: api_key }
+    end
+
+    def sign(options)
+      sorted_options_string = options.keys.sort.map do |key|
+        "%s=%s" % [key.to_s, options[key]]
+      end.join('') << api_secret
+      Digest::MD5.hexdigest(sorted_options_string)
+    end
+
+    def options(opts={})
+      {}
+    end
+  end
+
+  class ExtractOptions < BaseOptions
+    def options(opts={})
+      opts.merge!(base_options).merge!(method: method)
+      opts.merge!(build_boolean_options(opts, boolean_fields))
+      opts.merge!(sig: sign(opts))
+    end
+
+    def method
+      'imagga.colorsearch.extract'
+    end
+
+    def boolean_fields
+      [:extract_overall_colors, :extract_object_colors]
+    end
+  end
+
+  class RankOptions < BaseOptions
+    include Imagga::Exceptions
+
+    def options(opts={})
+      opts.merge!(base_options).merge!(
+        method:       method,
+        color_vector: opts.delete(:color_vector),
+        type:         (opts.delete(:type)  { raise_missing('type') }).to_s,
+        dist:         (opts.delete(:dist)  { raise_missing('dist') }).to_s,
+        count:        (opts.delete(:count) { raise_missing('count') }).to_s
+      )
+      opts.merge!(sig: sign(opts))
+    end
+
+    def method
+      'imagga.colorsearch.rank'
+    end
+  end
+
+  class CropOptions < BaseOptions
+    def options(opts={})
+      options = base_options.merge(opts).merge(method: method)
+      options.merge!(build_boolean_options(opts, :no_scaling))
+      options.merge!(sig: sign(options))
+    end
+
+    def method
+      'imagga.process.crop'
+    end
+  end
+end

data/lib/imagga/parametizer.rb

@@ -0,0 +1,18 @@
+module Imagga
+  module Parametizer
+    def build_comma_separated_string(objects, field, default_to=nil)
+      field_values = [objects].flatten.map{ |o| o.send(field) rescue default_to }
+      return if field_values.uniq == [default_to]
+      field_values.join(',')
+    end
+
+    def build_boolean_options(options, keys)
+      [keys].flatten.inject({}) do |result, key|
+        if options.keys.include?(key) && (value = [true, '1', 1].include?(options[key])  ? 1 : 0)
+          result[key] = value
+        end
+        result
+      end
+    end
+  end
+end

data/lib/imagga/rank_color_parametizer.rb

@@ -0,0 +1,17 @@
+module Imagga
+  class RankColorParametizer
+    include Parametizer
+
+    def parametrize(rank_color_or_colors)
+      { color_vector: build_vector(rank_color_or_colors) }
+    end
+
+    def build_vector(rank_color_or_colors)
+      [rank_color_or_colors].flatten.map{ |o| build_rank_color_string(o) rescue o }.join(',')
+    end
+
+    def build_rank_color_string(rank_color)
+      "%i,%i,%i,%i" % [rank_color.percent, rank_color.r, rank_color.g, rank_color.b]
+    end
+  end
+end