scaleapi-ruby 0.0.1

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "scaleapi-ruby"
+  gem.homepage = "http://github.com/wikiti/scaleapi-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby gem wrapper for the Scale API}
+  gem.description = %Q{A ruby gem wrapper for the Scale API, containing all the endpoints available.}
+  gem.email = "info@danielherzog.es"
+  gem.authors = ["Daniel Herzog"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scaleapi-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/scale.rb

@@ -0,0 +1,42 @@
+require 'uri'
+require 'time'
+require 'rest-client'
+require 'json'
+
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'scale/api'
+require 'scale/generic_error'
+require 'scale/http_error'
+
+require 'scale/resources/base'
+require 'scale/resources/task'
+
+require 'scale/endpoints/endpoint'
+
+require 'scale/endpoints/tasks/task_endpoint'
+require 'scale/endpoints/tasks/create_annotation_task'
+require 'scale/endpoints/tasks/create_categorization_task'
+require 'scale/endpoints/tasks/create_transcription_task'
+require 'scale/endpoints/tasks/create_comparison_task'
+require 'scale/endpoints/tasks/create_phonecall_task'
+require 'scale/endpoints/tasks/retrieve_task'
+require 'scale/endpoints/tasks/cancel_task'
+require 'scale/endpoints/tasks/list_tasks'
+
+require 'scale/callbacks/base'
+require 'scale/callbacks/task'
+
+module Scale
+  def self.setup(params = {})
+    Scale::API.new params
+  end
+
+  def self.hash(data = nil)
+    ActiveSupport::HashWithIndifferentAccess.new data
+  end
+
+  def self.descendants(klass)
+    ObjectSpace.each_object(::Class).select {|d| d < klass }
+  end
+end

data/lib/scale/api.rb

@@ -0,0 +1,104 @@
+module Scale
+  class API
+    DEFAULT_PARAMS = {
+      endpoint: 'https://api.scaleapi.com/v1/',
+      default_request_params: {}
+    }.freeze
+
+    attr_reader :endpoint, :api_key, :callback_key, :default_request_params, :params
+
+    def initialize(params = {})
+      params = DEFAULT_PARAMS.merge params
+
+      @params = Scale.hash(params)
+      @endpoint = fetch_attribute :endpoint
+      @api_key = fetch_attribute :api_key
+      @callback_key = fetch_attribute :callback_key
+      @default_request_params = fetch_attribute :default_request_params
+
+      validate!
+    end
+
+    def request(type, path, payload = {})
+      RestClient::Request.new(
+        method: type,
+        url: url(path),
+        user: api_key,
+        payload: Scale.hash(default_request_params).merge(Scale.hash(payload)),
+        headers: { accept: :json, content_type: :json }
+      ).execute
+    rescue RestClient::Exception => e
+      raise HttpError, e
+    end
+
+    def build_callback(data, type = 'task', options = {})
+      options = Scale.hash options
+      matchers = Scale.descendants(Scale::Callbacks::Base)
+      klass = matchers.find { |c| c.match? type }
+
+      validate_callback_handler! klass
+      validate_callback_token! options[:callback_key]
+
+      klass.new data
+    end
+
+    def valid_callback_key?(key)
+      key.to_s == callback_key.to_s
+    end
+
+    # Endpoint helper. If the method is not defined, then try looking into the available endpoints.
+    def method_missing(m, *array)
+      endpoint = Scale.descendants(Scale::Endpoints::Endpoint).find { |e| e.match? m }
+      return endpoint.new(self, *array).process if endpoint
+      super
+    end
+
+    protected
+
+    def validate!
+      validate_endpoint!
+      validate_api_key!
+      validate_callback_key!
+    end
+
+    def fetch_attribute(name)
+      params[name] || send(name)
+    end
+
+    def url(path)
+      "#{endpoint.end_with?('/') ? endpoint : endpoint + '/'}#{path}"
+    end
+
+    # -------------------
+    #      Validators
+    # -------------------
+
+    def validate_callback_handler!(klass)
+      raise GenericError, "Callback handler '#{name}' not found. Try #{matchers.map(&:shortcut).join ','}" unless klass
+    end
+
+    def validate_callback_token!(key)
+      return if callback_key.nil?
+      raise GenericError, "Invalid HTTP callback with key #{key}" unless valid_callback_key? key
+    end
+
+    def validate_callback_key!
+      return if callback_key.nil?
+      raise GenericError, invalid_attribute('callback_key') unless api_key.to_s != ''
+    end
+
+    def validate_endpoint!
+      valid = URI.parse "endpoint" rescue nil
+      raise GenericError, invalid_attribute('endpoint') unless valid
+    end
+
+    def validate_api_key!
+      raise GenericError, invalid_attribute('api_key') unless api_key.to_s != ''
+    end
+
+    def invalid_attribute(name)
+      "Invalid Scale API `#{name}`. Please, set a valid `#{name}` parameter"
+    end
+
+  end
+end

data/lib/scale/callbacks/base.rb

@@ -0,0 +1,25 @@
+module Scale
+  module Callbacks
+    class Base
+      attr_reader :response, :json
+
+      def initialize(data)
+        @json = Scale.hash(data)
+        @response = json[:response]
+      end
+
+      def status_code
+        response[:status_code]
+      end
+
+
+      def self.shortcut
+        raise NotImplementedError
+      end
+
+      def self.match?(method)
+        shortcut.to_s == method.to_s
+      end
+    end
+  end
+end

data/lib/scale/callbacks/task.rb

@@ -0,0 +1,23 @@
+module Scale
+  module Callbacks
+    class Task < Base
+      attr_reader :task
+
+      def initialize(json)
+        super
+        build_task
+      end
+
+      def self.shortcut
+        'task'
+      end
+
+      private
+
+      def build_task
+        task_data = json[:task].merge task_id: json[:task_id]
+        @task = Scale::Resources::Task.new task_data
+      end
+    end
+  end
+end

data/lib/scale/endpoints/endpoint.rb

@@ -0,0 +1,31 @@
+module Scale
+  module Endpoints
+    class Endpoint
+      attr_reader :api, :args, :params
+
+      def initialize(api, *args)
+        @api = api
+        @args = args
+        @params = Scale.hash(args.pop) if args.last.is_a?(Hash)
+      end
+
+      def process
+        raise NotImplementedError
+      end
+
+      def self.shortcut
+        nil
+      end
+
+      def self.match?(method)
+        shortcut.to_s == method.to_s
+      end
+
+      protected
+
+      def fetch_param(name)
+        params[name.to_s] || params[name.to_sym]
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/cancel_task.rb

@@ -0,0 +1,23 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class CancelTask < TaskEndpoint
+        attr_reader :task_id
+
+        def initialize(api, *args)
+          super
+          @task_id = args.first
+        end
+
+        def process
+          response = api.request :post, path("#{task_id}/cancel")
+          build_task response
+        end
+
+        def self.shortcut
+          'cancel_task'
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/create_annotation_task.rb

@@ -0,0 +1,16 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class CreateAnnotationTask < TaskEndpoint
+        def process
+          response = api.request :post, path('annotation'), params
+          build_task response
+        end
+
+        def self.shortcut
+          'create_annotation_task'
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/create_categorization_task.rb

@@ -0,0 +1,16 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class CreateCategorizationTask < TaskEndpoint
+        def process
+          response = api.request :post, path('categorize'), params
+          build_task response
+        end
+
+        def self.shortcut
+          'create_categorization_task'
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/create_comparison_task.rb

@@ -0,0 +1,16 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class CreateComparisonTask < TaskEndpoint
+        def process
+          response = api.request :post, path('comparison'), params
+          build_task response
+        end
+
+        def self.shortcut
+          'create_comparison_task'
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/create_phonecall_task.rb

@@ -0,0 +1,16 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class CreatePhonecallTask < TaskEndpoint
+        def process
+          response = api.request :post, path('phonecall'), params
+          build_task response
+        end
+
+        def self.shortcut
+          'create_phonecall_task'
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/create_transcription_task.rb

@@ -0,0 +1,16 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class CreateTranscriptionTask < TaskEndpoint
+        def process
+          response = api.request :post, path('transcription'), params
+          build_task response
+        end
+
+        def self.shortcut
+          'create_transcription_task'
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/list_tasks.rb

@@ -0,0 +1,27 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class ListTasks < TaskEndpoint
+        def process
+          response = api.request :get, path
+          build_tasks response
+        end
+
+        def self.shortcut
+          'tasks'
+        end
+
+        protected
+
+        def path
+          "tasks"
+        end
+
+        def build_tasks(response)
+          response = parse(response)
+          response.map { |obj| build_task obj }
+        end
+      end
+    end
+  end
+end

data/lib/scale/endpoints/tasks/retrieve_task.rb

@@ -0,0 +1,23 @@
+module Scale
+  module Endpoints
+    module Tasks
+      class RetrieveTask < TaskEndpoint
+        attr_reader :task_id
+
+        def initialize(api, *args)
+          super
+          @task_id = args.first
+        end
+
+        def process
+          response = api.request :get, path(task_id)
+          build_task response
+        end
+
+        def self.shortcut
+          'retrieve_task'
+        end
+      end
+    end
+  end
+end