imagga-categorization 0.0.2

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imagga-categorization.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    imagga-categorization (0.0.1)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    httparty (0.13.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+    rake (10.2.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  imagga-categorization!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 synoptase
+
+MIT License
+
+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,70 @@
+# Imagga::Categorization
+
+This gem is a simple wrapper around Imagga's categorization API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'imagga-categorization'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imagga-categorization
+
+## Usage
+
+**Create a client**
+
+``` ruby
+client = Imagga::Categorization::Client.new app_key: YOUR_API_KEY
+```
+
+**Consume an endpoint**
+
+The gem currently supports 3 endpoints:
+- `/draft/classify/{classifier_id}`
+- `/draft/classify/result/{ticket_id}`
+- `/draft/tasks/{task_id}`
+
+A call to any of these endpoints needs an `api_key`:
+> Before you begin you should [Request Your Free Trial](http://imagga.com/) from Imagga website in order to get an api_key. The api key is the only required authentication method currently and should be provided with every request as a parameter in the URL.
+
+Imagga's full api documentation [can be found here](http://docs.imagga.apiary.io/#classification). It lists the possible parameters for each endpoint.
+
+**Classify**
+
+```ruby
+parameters = {
+  "async": "1",
+  "urls": "https://fbcdn-sphotos-h-a.akamaihd.net/hphotos-ak-prn2/969321_526818917353598_661738580_n.jpg, http://example.com/image2.jpg"
+}
+response = client.classify(YOUR_CLASSIFIER_ID, parameters)
+```
+
+**Classify result**
+
+```ruby
+response = client.classify_result(ticket_id)
+```
+
+**Task result**
+
+```ruby
+response = client.task_result(task_id)
+```
+
+## TODO
+- Write some fracking unit tests
+
+## 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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :specrake

data/imagga-categorization.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imagga/categorization/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imagga-categorization"
+  spec.version       = Imagga::Categorization::VERSION
+  spec.authors       = ["Benjamin Grelié"]
+  spec.email         = ["benjamin@printicapp.com"]
+  spec.description   = %q{Ruby client for accessing Imagga categorization & training API}
+  spec.summary       = %q{Ruby client for accessing Imagga categorization & training API}
+  spec.homepage      = "http://github.com/printic/imagga-categorization"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/lib/imagga/categorization.rb

@@ -0,0 +1,9 @@
+require "imagga/categorization/version"
+require 'imagga/categorization/configuration'
+require 'imagga/categorization/client'
+
+module Imagga
+  module Categorization
+    extend Configuration
+  end
+end

data/lib/imagga/categorization/client.rb

@@ -0,0 +1,47 @@
+require "httparty"
+
+module Imagga
+  module Categorization
+    class Client
+      include HTTParty
+
+      # Define the same set of accessors as the Categorization module
+      attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+      def initialize(options={})
+        # Merge the config values from the module and those passed
+        # to the client.
+        merged_options = Categorization.options.merge(options)
+
+        # Copy the merged values to this client and ignore those
+        # not part of our configuration
+        Configuration::VALID_CONFIG_KEYS.each do |key|
+          send("#{key}=", merged_options[key])
+        end
+
+        # set the endpoint for HTTParty
+        self.class.base_uri self.endpoint.to_s
+
+        # set a default api_key parameter for each HTTParty request
+        @options = {
+          query: { api_key: self.api_key }
+        }
+      end
+
+      def classify(classifier_id, options={})
+        default_options = { async: 1 }
+        options.merge!(default_options)
+        options = @options.merge({ body: options.to_query })
+        self.class.post "/draft/classify/#{classifier_id}", options
+      end
+
+      def classify_result(ticket_id)
+        self.class.get "/draft/classify/result/#{ticket_id}", @options
+      end
+
+      def task_result(task_id)
+        self.class.get "/draft/tasks/#{task_id}", @options
+      end
+    end
+  end
+end

data/lib/imagga/categorization/configuration.rb

@@ -0,0 +1,37 @@
+module Imagga
+  module Categorization
+    module Configuration
+      VALID_CONNECTION_KEYS = [:endpoint, :user_agent].freeze
+      VALID_OPTIONS_KEYS    = [:api_key].freeze
+      VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+      DEFAULT_ENDPOINT      = 'http://api.imagga.com/'
+      DEFAULT_USER_AGENT    = "Imagga Categorization API ruby Gem #{Categorization::VERSION}".freeze
+
+      DEFAULT_APP_KEY       = nil
+
+      attr_accessor *VALID_CONFIG_KEYS
+
+      # Make sure we have the default values set when we get 'extended'
+      def self.extended(base)
+        base.reset
+      end
+
+      def reset
+        self.endpoint   = DEFAULT_ENDPOINT
+        self.user_agent = DEFAULT_USER_AGENT
+
+        self.api_key    = DEFAULT_APP_KEY
+      end
+
+      def configure
+        yield self
+      end
+
+      def options
+        Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+      end
+
+    end
+  end
+end

data/lib/imagga/categorization/version.rb

@@ -0,0 +1,5 @@
+module Imagga
+  module Categorization
+    VERSION = "0.0.2"
+  end
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+module Imagga
+  describe Categorization::Client do
+
+    before do
+      @keys = Categorization::Configuration::VALID_CONFIG_KEYS
+    end
+
+    describe 'with module configuration' do
+      before do
+        Categorization.configure do |config|
+          @keys.each do |key|
+            config.send("#{key}=", key)
+          end
+        end
+      end
+
+      after do
+        Categorization.reset
+      end
+
+      it "should inherit module configuration" do
+        api = Categorization::Client.new
+        @keys.each do |key|
+          api.send(key).should == key
+        end
+      end
+
+      describe 'with class configuration' do
+        before do
+          @config = {
+            :app_key    => 'ak',
+            :endpoint   => 'ep',
+            :user_agent => 'ua',
+          }
+        end
+
+        it 'should override module configuration' do
+          api = Categorization::Client.new(@config)
+          @keys.each do |key|
+            api.send(key).should == @config[key]
+          end
+        end
+
+        it 'should override module configuration after' do
+          api = Categorization::Client.new
+
+          @config.each do |key, value|
+            api.send("#{key}=", value)
+          end
+
+          @keys.each do |key|
+            api.send("#{key}").should == @config[key]
+          end
+        end
+
+      end
+    end
+
+    describe 'POST classify' do
+      it 'should have a classify method' do
+        client = Categorization::Client.new
+        client.should be_respond_to(:classify)
+      end
+
+      it "must parse the api response from JSON to Hash" do
+        client = Categorization::Client.new
+        client.classify('test').should be_instance_of Hash
+      end
+    end
+
+    describe 'GET classify result' do
+      it 'should have a classify_result method' do
+        client = Categorization::Client.new
+        client.should be_respond_to(:classify_result)
+      end
+
+      it "must parse the api response from JSON to Hash" do
+        client = Categorization::Client.new
+        client.classify_result('ticket_id').should be_instance_of Hash
+      end
+    end
+
+    describe 'GET tasks result' do
+      it 'should have a tasks method' do
+        client = Categorization::Client.new
+        client.should be_respond_to(:tasks)
+      end
+
+      it "must parse the api response from JSON to Hash" do
+        client = Categorization::Client.new
+        client.classify_result('task_id').should be_instance_of Hash
+      end
+    end
+
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module Imagga
+  describe Categorization do
+
+    describe '.app_key' do
+      it 'should return default key' do
+        Categorization.app_key.should == Categorization::Configuration::DEFAULT_APP_KEY
+      end
+    end
+
+    describe '.user_agent' do
+      it 'should return default user agent' do
+        Categorization.user_agent.should == Categorization::Configuration::DEFAULT_USER_AGENT
+      end
+    end
+
+    after do
+      Categorization.reset
+    end
+
+    describe '.configure' do
+      Categorization::Configuration::VALID_CONFIG_KEYS.each do |key|
+        describe ".#{key}" do
+          it 'should return the default value' do
+            Categorization.send(key).should == Categorization::Configuration.const_get("DEFAULT_#{key.upcase}")
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/imagga-categorization_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+module Imagga
+  describe Categorization do
+    it 'should have a version' do
+      Categorization::VERSION.should_not be_nil
+    end
+    it "should test something" do
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "imagga/categorization"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: imagga-categorization
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Grelié
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for accessing Imagga categorization & training API
+email:
+- benjamin@printicapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- imagga-categorization.gemspec
+- imagga-categorization_spec.rb
+- lib/imagga/categorization.rb
+- lib/imagga/categorization/client.rb
+- lib/imagga/categorization/configuration.rb
+- lib/imagga/categorization/version.rb
+- spec/lib/client_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/imagga-categorization_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/printic/imagga-categorization
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby client for accessing Imagga categorization & training API
+test_files:
+- spec/lib/client_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/imagga-categorization_spec.rb
+- spec/spec_helper.rb
+has_rdoc: