openamplify 0.2.3 → 0.3.0

data/lib/openamplify/analysis/context.rb

@@ -0,0 +1,67 @@
+module OpenAmplify
+
+  module  Analysis
+
+    class Context
+      VALID_OPTIONS_KEYS = OpenAmplify::Configuration::VALID_OPTIONS_KEYS + [:input]
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      attr_accessor :client
+      attr_reader   :result
+
+      def initialize(client, input, options)
+        self.client = client
+        self.input  = input
+
+        merged_options = OpenAmplify.options.merge(options)
+        OpenAmplify::Configuration::VALID_OPTIONS_KEYS.each do |key|
+          send("#{key}=", merged_options[key])
+        end
+      end
+
+      # The empty?, to_s, to_str are to make our object play
+      # with others that expect a string.
+      #
+      # Example, you can do this:
+      #   puts result
+      #
+      # instead of:
+      #   puts result.to_s
+
+      def empty?
+        result.empty?
+      end
+
+      def to_s
+        "#{result}"
+      end
+      alias_method :to_str, :to_s
+
+      # Support various conversion helpers
+
+      %w(xml json json_js rdf rdfa csv signals pretty dart oas).each do |format|
+        define_method("to_#{format}") do
+          @result = call(:output_format => format)
+        end
+      end
+
+      private
+
+      def result
+        @result ||= call
+      end
+
+      def call(options={})
+        @result = client.request_analysis(request_analysis_options.merge(options))
+      end
+
+      def request_analysis_options
+        Hash[* VALID_OPTIONS_KEYS.map { |key| [key, send(key) ]}.flatten ]
+      end
+
+    end # Context
+
+  end # Analysis
+
+end

data/lib/openamplify/client.rb

@@ -0,0 +1,82 @@
+require 'openamplify/analysis/context'
+require 'openamplify/connection'
+require 'openamplify/request'
+
+module OpenAmplify
+  # Provides access to the OpenAmplify API http://portaltnx20.openamplify.com/AmplifyWeb_v20/
+  #
+  # Basic usage of the library is to call supported methods via the Client class.
+  #
+  #   text = "After getting the MX1000 laser mouse and the Z-5500 speakers i fell in love with logitech"
+  #   OpenAmplify::Client.new.amplify(text)
+
+  class Client
+    include OpenAmplify::Connection
+    include OpenAmplify::Request
+
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options={})
+      merged_options = OpenAmplify.options.merge(options)
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def amplify(input, options={})
+      options = analysis_options.merge(options)
+      Analysis::Context.new(self, input, options)
+    end
+
+    def analysis_options
+      Hash[ *Configuration::VALID_OPTIONS_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+
+    def request_analysis(options)
+      params = prepare_request_params(options)
+
+      case self.method
+      when :post
+        post(self.endpoint, params)
+      else
+        get(self.endpoint, params)
+      end
+    end
+
+    # @deprecated Please use {#amplify} instead
+    def analyze_text(input)
+      warn "[DEPRECATION] `analyze_text` is deprecated.  Please use `amplify` instead."
+      amplify input
+    end
+
+    # @deprecated Please use {#endpoint} instead
+    def base_url=(url)
+      warn "[DEPRECATION] `base_url` is deprecated.  Please use `endpoint` instead."
+      self.endpoint = url
+    end
+
+    private
+
+    # Formulate the parameters that is understood by
+    # the OpenAmplify webservice.
+    # ex: :api_key  becomes  'apikey'
+    def prepare_request_params(options)
+      params = detect_request_input options.delete(:input)
+
+      options.inject(params) do |params, kv|
+        key, value = kv
+        params.merge!("#{key.to_s.downcase.gsub(/_+/, '')}" => value)
+      end
+    end
+
+    def detect_request_input(input)
+      if input =~ /^https?:\/\//
+        { 'sourceurl' => input }
+      else
+        { 'inputtext' => input }
+      end
+    end
+
+  end # Client
+
+end

data/lib/openamplify/configuration.rb

@@ -0,0 +1,54 @@
+require 'openamplify/version'
+
+# TODO: output_format, analysis, scoring can be specied in the client and becomes the default unless overriden
+
+module OpenAmplify
+  # Defines constants and methods for configuring a client
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :method, :adapter].freeze
+    VALID_OPTIONS_KEYS    = [:api_key, :analysis, :output_format, :scoring].freeze
+
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_ENDPOINT      = 'http://portaltnx20.openamplify.com/AmplifyWeb_v21/AmplifyThis'
+    DEFAULT_HTTP_METHOD   = :get
+    DEFAULT_HTTP_ADAPTER  = :net_http
+    DEFAULT_USER_AGENT    = "OpenAmplify Ruby Gem #{OpenAmplify::VERSION}".freeze
+
+    DEFAULT_API_KEY       = nil
+    DEFAULT_ANALYSIS      = :all
+    DEFAULT_OUTPUT_FORMAT = :xml
+    DEFAULT_SCORING       = :standard
+    DEFAULT_SOURCE_URL    = nil
+    DEFAULT_INPUT_TEXT    = nil
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+
+    def reset
+      self.endpoint      = DEFAULT_ENDPOINT
+      self.method        = DEFAULT_HTTP_METHOD
+      self.adapter       = DEFAULT_HTTP_ADAPTER
+      self.user_agent    = DEFAULT_USER_AGENT
+
+      self.api_key       = DEFAULT_API_KEY
+      self.analysis      = DEFAULT_ANALYSIS
+      self.output_format = DEFAULT_OUTPUT_FORMAT
+      self.scoring       = DEFAULT_SCORING
+    end
+
+  end # Configuration
+
+end

data/lib/openamplify/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'openamplify/response/raise_client_error'
+require 'openamplify/response/raise_server_error'
+
+module OpenAmplify
+  module Connection
+
+    private
+
+    def connection(options)
+      default_options = {
+        :url => options.fetch(:endpoint, endpoint)
+      }
+
+      @connection ||= Faraday.new(default_options) do |builder|
+        builder.use OpenAmplify::Response::RaiseClientError
+        builder.use OpenAmplify::Response::RaiseServerError
+
+        # TODO: Make logging optional
+        # builder.response :logger
+
+        builder.adapter adapter
+      end
+    end
+
+  end # Connection
+
+end

data/lib/openamplify/error.rb

@@ -0,0 +1,20 @@
+module OpenAmplify
+
+  class Error < StandardError
+    attr_reader :http_headers
+
+    def initialize(message, http_headers)
+      @http_headers = http_headers
+      super(message)
+    end
+
+  end # Error
+
+  class Error::ServerError        < OpenAmplify::Error; end
+  class Error::ServiceUnavailable < Error::ServerError; end
+
+  class Error::ClientError     < OpenAmplify::Error; end
+  class Error::Forbidden       < Error::ClientError; end
+  class Error::BadRequest      < Error::ClientError; end
+  class Error::RequestTooLarge < Error::ClientError; end
+end

data/lib/openamplify/request.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+require 'uri'
+
+module OpenAmplify
+  # Handless HTTP requests
+  module Request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    private
+
+    def request(method, path, params, options)
+      response = connection(options).run_request(method, nil, nil, nil) do |request|
+        request.options[:raw] = true if options[:raw]
+
+        case method.to_sym
+        when :get 
+          request.url(path, params)
+        when :post
+          request.path = path
+          request.body = params unless params.empty?
+        end
+      end
+
+      options[:raw] ? response : response.body
+    end
+
+  end # Request
+
+end

data/lib/openamplify/response/raise_client_error.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module OpenAmplify
+
+  module Response
+
+    class RaiseClientError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status  = env[:status].to_i
+        body    = env[:body]
+        headers = env[:response_headers]
+
+        case status
+        when 400
+          raise OpenAmplify::Error::BadRequest.new body, headers
+        when 403
+          raise OpenAmplify::Error::Forbidden.new body, headers
+        when 413
+          raise OpenAmplify::Error::RequestTooLarge.new body, headers
+        end
+      end
+
+    end # RaiseClientError
+
+  end # Response
+
+end

data/lib/openamplify/response/raise_server_error.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'openamplify/error'
+
+module OpenAmplify
+  module Response
+    class RaiseServerError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status  = env[:status].to_i
+        body    = env[:body]
+        headers = env[:response_headers]
+
+        case status
+        when 503
+          raise OpenAmplify::Error::ServiceUnavailable.new "503 No server is available to handle this request.", headers
+        end
+      end
+
+    end # RaiseServerError
+
+  end # Response
+
+end

data/lib/openamplify/version.rb

@@ -0,0 +1,3 @@
+module OpenAmplify
+  VERSION = "0.3.0"
+end

data/openamplify.gemspec

@@ -1,56 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "openamplify/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{openamplify}
-  s.version = "0.2.3"
+  s.name        = "openamplify"
+  s.version     = OpenAmplify::VERSION
+  s.authors     = ["Greg Moreno"]
+  s.email       = ["greg.moreno@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Wrapper for the OpenAmplify API"
+  s.description = "The OpenAmplify API reads text you supply and returns linguistic data explaining and classifying the content."
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Greg Moreno"]
-  s.date = %q{2010-06-22}
-  s.description = %q{The OpenAmplify API reads text you supply and returns linguistic data explaining and classifying the content.}
-  s.email = %q{rubyoncloud@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "History",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION.yml",
-     "lib/openamplify.rb",
-     "lib/openamplify/validations.rb",
-     "openamplify.gemspec",
-     "test/test_openamplify.rb"
-  ]
-  s.homepage = %q{http://github.com/gregmoreno/openamplify}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Wrapper for the OpenAmplify API}
-  s.test_files = [
-    "test/test_openamplify.rb"
-  ]
+  s.rubyforge_project = "openamplify"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, ["~> 1.2"])
-      s.add_development_dependency(%q<shoulda>, ["~> 2.11"])
-    else
-      s.add_dependency(%q<json>, ["~> 1.2"])
-      s.add_dependency(%q<shoulda>, ["~> 2.11"])
-    end
-  else
-    s.add_dependency(%q<json>, ["~> 1.2"])
-    s.add_dependency(%q<shoulda>, ["~> 2.11"])
-  end
-end
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
+  s.add_dependency 'faraday'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'nokogiri'
+  s.add_development_dependency 'json'
+end

data/test/fixtures/input.txt

@@ -0,0 +1,2 @@
+After getting the MX1000 laser mouse and the Z-5500 speakers i fell in
+love with logitech

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'openamplify'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'awesome_print'
+
+OpenAmplify.configure do |config|
+  config.api_key = ENV['OPEN_AMPLIFY_KEY']
+end
+
+def amplify_input
+  fpath = File.dirname(__FILE__) + '/fixtures/input.txt'
+  @amplify_params ||= File.read(fpath)
+end