openamplify 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Greg Moreno
+
+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.rdoc

@@ -0,0 +1,75 @@
+= OpenAmplify
+
+The OpenAmplify API reads text you supply and returns linguistic data 
+explaining and classifying the content. What you do with that analysis is, 
+in the fine tradition of APIs and mashups, up to you. Some possibilities 
+might include pairing ads with articles, creating rich tag-clouds, or 
+monitoring the tone of forum threads.
+
+== Helpful links
+
+* <b>Overview:</b> http://community.openamplify.com/blogs/quickstart/pages/overview.aspx
+
+== Usage
+
+=== Show the result from OpenAmplify as a Hash
+
+  require 'openamplify'
+
+  API_KEY = "register to get a key"
+  client = OpenAmplify::Client.new(:api_key => API_KEY)
+
+  text = "After getting the MX1000 laser mouse and the Z-5500 speakers i fell in love with logitech"
+  response = client.analyze_text(text)
+
+  # List all the keys and values returned by OpenAmplify
+  response.each do |k, v|
+    pp k
+    pp v
+  end
+
+
+  # 'response' works like a Hash
+  puts response['Topics']
+
+=== Output Format
+
+In case you need a different format, OpenAmplify supports XML, JSON, RDF, CSV.
+It can also return the result as a fancy HTML page.
+
+  # assuming you use Nokogiri
+  doc = Nokogiri::XML(response.to_xml)
+
+  # or you want a JSON
+  json = JSON.parse(response.to_json)
+
+  # you should really try the pretty formats
+  puts response.to_pretty
+  # or
+  puts response.to_signals
+
+=== Analysis options
+
+By default, OpenAmplify returns a number of 'signals' about your text.
+You can limit the result by setting the 'analysis' option.
+
+The different options and explanations are available at http://community.openamplify.com/blogs/quickstart/pages/overview.aspx
+
+  client = OpenAmplify::Client.new(:api_key => API_KEY, :analysis => 'topics')
+
+  # or if you have a client instance already
+  client.analysis = 'topics'
+
+  response = client.analyze_text(text)
+  response['Topics']  # => should be another big Hash of key-value pairs
+  response['Demographics'] # => nil
+
+=== Request URL
+
+In case you are wondering what the request URL looks like:
+
+  response.request_url
+
+If someday, OpenAmplify decides to change their API URL:
+
+  client.base_url = 'http://newurl'

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "openamplify"
+    gem.summary     = "Wrapper for the OpenAmplify API"
+    gem.description = "The OpenAmplify API reads text you supply and returns linguistic data explaining and classifying the content."
+    gem.email       = "rubyoncloud@gmail.com"
+    gem.homepage    = "http://github.com/gregmoreno/openamplify"
+    gem.authors     = ["Greg Moreno"]
+    gem.add_dependency 'json'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "openamplify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:minor: 1
+:build: 
+:patch: 0

data/lib/openamplify.rb

@@ -0,0 +1,121 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module OpenAmplify
+  API_URL = "http://portaltnx20.openamplify.com/AmplifyWeb_v20/AmplifyThis"
+
+  class Client
+    def initialize(options)
+      @options = { :base_url => API_URL }
+      @options.merge!(OpenAmplify.symbolize_keys(options))
+    end
+
+    def analyze_text(text)
+      Response.new(:base_url => @options[:base_url], :query => query.merge(:inputText => text))
+    end
+    
+    %w(api_key analysis base_url).each do |attr|
+      class_eval <<-EOS
+        def #{attr}
+          @options[:#{attr}]
+        end
+
+        def #{attr}=(v)
+          @options[:#{attr}] = v 
+        end
+      EOS
+    end
+
+    private
+
+    def query
+      q = { :apiKey => @options[:api_key] }
+      q.merge!(:analysis => @options[:analysis]) if @options[:analysis]
+      q
+    end
+
+  end # OpenAmplify::Client 
+
+  # Contains the response from OpenAmplify
+  class Response
+    include Enumerable
+
+    def initialize(options)
+      @options = options
+    end
+
+    def request_url
+      @request_url ||= compose_url(@options[:base_url], @options[:query]) 
+    end
+    
+    def response
+      @response ||= get_response
+    end
+  
+    # Make this class behave like a Hash
+    # TODO: Add more methods
+    
+    def each
+      response.each do |k, v|
+        yield(k, v)
+      end
+    end
+    
+    ['has_key?', '==', '[]', 'fetch', 'empty?', 'include?', 'inspect', 
+      'key?', 'keys', 'length', 'member?', 'merge', 'merge!'
+    ].each do |method|
+      class_eval <<-EOS
+        def #{method}(*args)
+          response.send('#{method}', *args)
+        end
+      EOS
+    end
+    ## Hash methods end here
+    
+    # Support the different formats. Note this would entail another request
+    # to openamplify
+    %w(xml json rdf csv oas signals pretty).each do |format|
+      class_eval <<-EOS
+        def to_#{format}
+          get('#{format}')
+        end
+      EOS
+    end
+
+    private
+
+    def compose_url(path, params)
+      path + '?' + URI.escape(params.collect{ |k, v| "#{k}=#{v}" }.join('&'))
+    end
+  
+    def get_response
+      response = get('json') 
+      result   = JSON.parse(response)
+     
+      if analysis = @options[:query][:analysis]
+        name = analysis.sub(/./){ |s| s.upcase }
+        result["ns1:#{name}Response"]["#{name}Return"]
+      else
+        result['ns1:AmplifyResponse']['AmplifyReturn']
+      end
+    end
+
+    def get(format)
+      params = @options[:query]
+      url    = compose_url(@options[:base_url], params.merge(:outputFormat => format))
+      Net::HTTP.get_response(URI.parse(url)).body
+    end
+
+  end # OpenAmplify::Response
+
+  private 
+
+  def self.symbolize_keys(hash)
+    hash.inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+end # module OpenAmplify

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: openamplify
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Greg Moreno
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: The OpenAmplify API reads text you supply and returns linguistic data explaining and classifying the content.
+email: rubyoncloud@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- History
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/openamplify.rb
+has_rdoc: true
+homepage: http://github.com/gregmoreno/openamplify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper for the OpenAmplify API
+test_files: []
+