openamplify 0.2.3 → 0.3.0

data/.gitignore

@@ -5,3 +5,6 @@ tmp/
 log/
 pkg/
 *.swp
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# See openamplify.gemspec for the dependencies
+gemspec

data/History

@@ -1,3 +1,7 @@
+0.3.0 - TBA
+      * Supports OpenAmplify v3.0 by default
+      * Major code revamp
+      * Added command-line tool 'openamplify'
 0.2.2 - Jun 14, 2010
       * refactored the code
 0.2.1 - Jun 13, 2010

data/README.rdoc

@@ -6,9 +6,13 @@ 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.
 
+=== Supported version
+
+2.1
+
 == Helpful links
 
-* <b>Overview:</b> http://community.openamplify.com/blogs/quickstart/pages/overview.aspx
+* <b>Overview:</b> http://openamplify.com/quickstart
 
 == Install
 
@@ -16,82 +20,93 @@ monitoring the tone of forum threads.
 
 == Usage
 
-=== Show the result from OpenAmplify as a Hash
+=== Configure
 
-  require 'openamplify'
+  OpenAmplify.configure do |config|
+    config.api_key = 'YOUR_API_KEY'
 
-  API_KEY = "register to get a key"
-  client = OpenAmplify::Client.new(:api_key => API_KEY)
+    # default :get
+    config.method = :post
 
-  text = "After getting the MX1000 laser mouse and the Z-5500 speakers i fell in love with logitech"
-  response = client.analyze_text(text)
+    # default :xml
+    config.output_format = :json
 
-  # List all the keys and values returned by OpenAmplify
-  response.each do |k, v|
-    pp k
-    pp v
+    # default :all
+    config.analysis = :topics
+
+    # default :standard
+    config.scoring = :todo
   end
 
+Default settings can be overriden by the client
 
-  # 'response' works like a Hash
-  puts response['Topics']
+  client = OpenAmplify::Client.new(:method => :get)
 
-  # or use the shortcuts
-  response.top_topics
-  response.proper_nouns
-  response.locations
-  response.domains
+Or when you start 'amplifying'.
+
+  result = client.amplify('input', :output_format => :rdf)
+
+=== Usage
+
+  client = OpenAmplify::Client.new
 
-=== Output Format
+  text = "After getting the MX1000 laser mouse and the Z-5500 speakers i fell in love with logitech"
+  analysis = client.amplify(text)
+  puts analysis  # default as xml
+
+It knows if the input is a URL and uses the right webservice param (ie. sourceurl)
+
+  client.amplify('http://theonion.com')
 
 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)
+  doc = Nokogiri::XML(analysis.to_xml)
 
   # or you want a JSON
-  json = JSON.parse(response.to_json)
+  json = JSON.parse(analysis.to_json)
 
   # you should really try the pretty formats
-  puts response.to_pretty
+  puts analysis.to_pretty
   # or
-  puts response.to_signals
-
-=== Analysis options
+  puts analysis.to_signals
 
-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
+== Command-line 
 
-  client = OpenAmplify::Client.new(:api_key => API_KEY, :analysis => 'topics')
+OpenAmplify gem comes with a command-line tool.
 
-  # or if you have a client instance already
-  client.analysis = 'topics'
+  openamplify --api-key=APIKEY --format=json --analysis=topics "sample input text"
 
-  response = client.analyze_text(text)
-  response['Topics']  # => should be another big Hash of key-value pairs
-  response['Demographics'] # => nil
+== Upgrading from 0.2.3 to 0.3.0
 
-=== POST method
+Note 0.3.0 is a major revamp of the code. In general, it is better but
+if you encounter a problem, please let me know. Or better, submit a pull
+request.
 
-By default, GET is used. If you need to analyze lots of text, use POST
+The following methods are deprecated and will be removed in 0.3.1
 
-  client = OpenAmplify::Client.new(:api_key => API_KEY, :method => :post)
+  client.analyze_text('input')
+  client.base_url = 'http://domain.dev'
 
-  # or
-  client.method = :post
-  
-=== Request URL
-
-In case you are wondering what the request URL looks like:
+The following methods are no longer supported. I figure it's better to
+let the caller decide how they want to traverse the results.
 
-  response.request_url
+  # Treating the result as hash
+  response.each do |k, v|
+    pp k
+    pp v
+  end
 
-If someday, OpenAmplify decides to change their API URL:
+  # 'response' works like a Hash
+  puts response['Topics']
 
-  client.base_url = 'http://newurl'
+  # Nor the shortcuts
+  response.top_topics
+  response.proper_nouns
+  response.locations
+  response.domains
 
 == Testing
   rake test OPEN_AMPLIFY_KEY=YOUR_KEY

data/Rakefile

@@ -1,61 +1,71 @@
-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", "~>1.2"
-
-    gem.add_development_dependency "shoulda", "~> 2.11"  
-
-    # 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 'bundler/gem_tasks'
 
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
+Rake::TestTask.new do |test|
   test.libs << 'lib' << 'test'
   test.ruby_opts << "-rubygems"
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
-# Note to run a single test do:
-# ruby -Ilib test/test_foo.rb
-
-
-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
+#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", "~>1.2"
+#
+#    gem.add_development_dependency "shoulda", "~> 2.11"  
+#
+#    # 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.ruby_opts << "-rubygems"
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#end
+## Note to run a single test do:
+## ruby -Ilib test/test_foo.rb
+#
+#
+#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/TODO

@@ -0,0 +1 @@
+* Support RequestID, Cache

data/bin/openamplify

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'awesome_print'
+
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require 'openamplify'
+
+opts = {
+  :output_format => :json
+}
+
+OptionParser.new do |o|
+  o.banner = "USAGE: #{$0} [options] input"
+
+  o.on('--api-key [APIKEY]', 'API key') do |f|
+    opts[:api_key] = f
+  end
+
+  o.on('-f', '--format [FORMAT]', 'Output format: json (default), xml, rdf, rdfa, csv signals, pretty, oas dart') do |f|
+    opts[:output_format] = f.downcase.to_sym
+  end
+
+  o.on('--analysis [TYPE]', 'Type of signals request: all (default), toptopics, topics, actions, topicintentions, demographics, styles') do |f|
+    opts[:analysis] = f.downcase.to_sym
+  end
+
+  # TODO: Add more options
+
+end.parse!
+
+client   = OpenAmplify::Client.new(opts)
+input    = ARGV.first
+response = client.amplify(input)
+
+ap response
+
+case opts[:output_format]
+  when :json
+    require 'json'
+    puts JSON.pretty_generate JSON.load(response)
+  when :xml, :rdf, :rdfa
+    require 'rexml/document'
+    doc = REXML::Document.new(response)
+    doc.write($stdout, 2)
+  else
+    puts response
+end
+

data/lib/openamplify.rb

@@ -1,168 +1,23 @@
-require 'net/http'
-require 'uri'
-require 'json'
+require 'openamplify/configuration'
+require 'openamplify/client'
 
 module OpenAmplify
-  API_URL = "http://portaltnx20.openamplify.com/AmplifyWeb_v20/AmplifyThis"
+  extend Configuration
 
-  class Client
-    def initialize(options={})
-      @options = { :api_url => API_URL, :method => :get }
-      @options.merge!(OpenAmplify.symbolize_keys(options))
-    end
-
-    def analyze_text(text)
-      OpenAmplify.validate_client!(self)
-      Response.new(self, :query => query.merge(:inputText => text), :method => @options[:method])
-    end
-    
-    %w(api_key analysis api_url method).each do |attr|
-      class_eval <<-EOS
-        def #{attr}
-          @options[:#{attr}]
-        end
-
-        def #{attr}=(v)
-          @options[:#{attr}] = v 
-        end
-      EOS
-    end
-    
-    def fetch(params, method)
-      raise OpenAmplify::NotSupported unless [:get, :post].include?(method.to_sym)
-      Client::send(method, self.api_url, params)
-    end
-
-    def self.compose_url(path, params)
-      path + '?' + URI.escape(params.collect{ |k,v| "#{k}=#{v}" }.join('&'))
-    end
-
-
-    private
-
-
-    def query
-      q = { :apiKey => @options[:api_key] }
-      q.merge!(:analysis => @options[:analysis]) if @options[:analysis]
-      q
-    end
-
-    def self.get(path, params)
-      uri      = URI.parse(compose_url(path, params))
-      response = Net::HTTP.get_response(uri)
-      OpenAmplify.validate_response!(response) 
-      response.body
-    end
-
-    def self.post(path, params)
-      uri      = URI::parse(path)
-      response = Net::HTTP.post_form(uri, params)
-      OpenAmplify.validate_response!(response)
-      response.body
-    end
-
-  end # OpenAmplify::Client 
-
-
-  # Contains the response from OpenAmplify
-  class Response
-    include Enumerable
-
-    def initialize(client, options)
-      @client  = client
-      @options = options
-    end
-
-    def request_url
-      @request_url ||= Client.compose_url(@client.api_url, @options[:query]) 
-    end
-
-    def reload
-      response
-    end
-    
-    def each
-      response.each do |k, v|
-        yield(k, v)
-      end
-    end
-
-    def method_missing(name, *args, &block)
-      response.send(name, *args, &block)
-    end
-     
-    # 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}
-          fetch_as_format(:#{format})
-        end
-      EOS
-    end
-
-    def top_topics
-      items = response && response['Topics']['TopTopics']
-    end
-
-    def proper_nouns
-      items = response && response['Topics']['ProperNouns']
-
-      return items if items.is_a?(Array)
-
-      # I'm not sure if this is the default behavior if
-      # only a single item is found, or if it is a bug
-      # TODO: check other helpers as well
-      if items.is_a?(Hash)
-        return [ items['TopicResult'] ]
-      end
-    end
-
-    def locations
-      response && response['Topics']['Locations']
-    end
-
-    def domains
-      response && response['Topics']['Domains']
-    end
-
-    def styles
-      response && response['Styles']
-    end
-
-    private
-
-    def response
-      @response ||= fetch_response
-    end
-  
-    def fetch_response
-      response = fetch_as_format(: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 fetch_as_format(format)
-      @client.fetch(@options[:query].merge(:outputFormat => format), @options[:method])
-    end
+  def new(options={})
+    Client.new(options)
+  end
 
-  end # OpenAmplify::Response
+  # Delegate to OpenAmplify::Client
 
-  private 
+  def method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
+  end
 
-  def self.symbolize_keys(hash)
-    hash.inject({}) do |options, (key, value)|
-      options[(key.to_sym rescue key) || key] = value
-      options
-    end
+  def respond_to?(method, include_private = false)
+    new.respond_to?(method, include_private) || super(method, include_private)
   end
 
 end # module OpenAmplify
 
-require 'openamplify/validations'