ingenia_api 1.0.6

data/examples/classify.rb

@@ -0,0 +1,9 @@
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'yaml'
+require 'ingenia_api'
+
+Ingenia::Api.api_key = "API_KEY"
+
+puts Ingenia::Api.classify "What kind of cheese is the best cheese?"

data/examples/console.rb

@@ -0,0 +1,13 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ingenia_api'
+
+
+#
+# Setup
+#
+# Set API key to the test user for this gem
+Ingenia::Api.api_key = "API_KEY"
+
+require 'irb'
+ARGV.clear
+IRB.start

data/examples/helper.rb

@@ -0,0 +1,15 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'colorize'
+require 'rest_client'
+
+# log rest client activity
+# RestClient.log = STDOUT
+
+
+def example title
+  puts "|| #{title} ||\n".yellow
+
+  yield
+
+  puts "\n\n"
+end

data/examples/items.rb

@@ -0,0 +1,124 @@
+require './helper'
+
+##
+# Run a full set of API calls related to items
+##
+
+
+# Set API key to the test user for this gem
+require 'ingenia_api'
+
+Ingenia::Api.api_key = "API_KEY"
+Ingenia::Api.version = 2.0
+##
+# Create/Train
+#
+# - Creating items with (optional) tags is the same as training.
+# - All new items belong to your first bundle unless specified with the bundle_id param
+# - If the same text is sent twice, the old record is overwritten unless the 'update_existing' param is set to false
+#
+example "Create/train" do
+  big_text = "I like cake " * 1000
+  new_item = Ingenia::Item.create :json => { :text => big_text, :tags => [ 'food', 'cake', 'obsession'] }
+  @new_item_id = new_item['id']
+
+  puts "new item: "
+  puts "#{new_item}".green
+
+  # Tidy up
+  Ingenia::Item.destroy(@new_item_id)
+
+  # request full text response
+  big_text = "I like cake " * 1001
+  new_item = Ingenia::Item.create :json => { :text => big_text, :tags => [ 'food', 'cake', 'obsession'] }, :full_text => true
+  @new_item_id = new_item['id']
+
+  puts "new item with full text: "
+  puts "#{new_item}".green
+
+
+  # create without updating existing
+  response = Ingenia::Item.create :json => { :text => new_item['text'], :tags => [ 'not', 'changed' ] }, :update_existing => false
+  puts 'unchaged item'
+  puts "#{response}".green
+end
+
+
+##
+# Index normal
+#
+example "Index normal" do
+  items = Ingenia::Item.all
+
+  puts "got #{items.length} items"
+  puts "\n First Item: "
+  puts "#{items.first}".green
+
+  @test_item_id = items.first['id']
+end
+
+##
+# Index full text
+#
+example "Index full text" do
+  items = Ingenia::Item.all(:full_text => "true")
+
+  puts "got #{items.length} items"
+  puts "\n First Item: "
+  puts "#{items.first}".green
+
+  @test_item_id = items.first['id']
+end
+
+##
+# Show
+#
+example "Show" do
+  test_item = Ingenia::Item.get(@new_item_id, :full_text => false )
+  puts "Quick view: "
+  puts "#{test_item}".green
+
+  # Get it with full text
+  @test_item = Ingenia::Item.get(@new_item_id, :full_text => true )
+  puts "\n Full text view: "
+  puts "#{@test_item}".green
+end
+
+
+##
+# Update
+#
+example "Update" do
+  response = Ingenia::Item.update(@test_item_id, :json => { :text => "this is some test update text for testing the API" })
+
+  puts "updated item:"
+  puts "#{response}".green
+
+  # Update its tags
+  response = Ingenia::Item.update(@test_item_id, :json => { :text => "this is some test update text for testing the API", :tags => ['api', 'testing'] })
+  puts "#{response}".green
+end
+
+
+##
+# Destroy
+#
+example "Destroy" do
+  # Remove this new item
+  response = Ingenia::Item.destroy(@test_item_id)
+  puts "#{response}".green
+end
+
+##
+# Similar to - using auto matching
+#
+example "similar to" do
+  response = Ingenia::Item.similar_to(@test_item_id)
+
+  puts "#{response}".green
+end
+example "similar to - matching on words" do
+  response = Ingenia::Item.similar_to(@test_item_id, :words)
+
+  puts "#{response}".green
+end

data/examples/run_all_examples.rb

@@ -0,0 +1,7 @@
+# Run all the examples
+
+Dir.foreach('./') do |item|
+  next if ['.', '..', 'console.rb'].include? item
+
+  require("./#{item}")
+end

data/examples/similar_to.rb

@@ -0,0 +1,23 @@
+require './helper'
+
+
+# RestClient.log = STDOUT
+require 'ingenia_api'
+Ingenia::Api.api_key = "API_KEY"
+
+# similar to text
+# Moved to Ingenia::Item.similar_to
+
+# similar to item
+example "similar to item" do
+  response = Ingenia::Api.similar_to :item_id => Ingenia::Item.all.first['id']
+
+  puts "#{response}".green
+end
+
+# similar to tags
+example "similar to tags" do
+  response = Ingenia::Api.similar_to :tag_ids => [ 1, 3, 5 ]
+  
+  puts "#{response}".green
+end

data/examples/summarize.rb

@@ -0,0 +1,11 @@
+require './helper'
+
+require 'ingenia_api'
+Ingenia::Api.api_key = "API_KEY"
+
+# summarise some text
+example "summarize" do
+  Ingenia::Api.summarize :text => "What kind of cheese is the best cheese?"
+end
+
+

data/examples/tag_sets.rb

@@ -0,0 +1,75 @@
+require './helper'
+
+##
+# Run a full set of API calls on tag_sets
+##
+
+
+#
+# Setup
+#
+# Set API key to the test user for this gem
+require 'ingenia_api'
+Ingenia::Api.api_key = "API_KEY"
+Ingenia::Api.version = 2.0
+
+##
+# Create
+#
+example "Create" do
+  # Create a new tag_set
+  @new_test_tag_set = Ingenia::TagSet.create(:name => "new tag set name")
+  puts "\n created a new tag_set:"
+  puts "#{@new_test_tag_set}".green
+end
+
+
+##
+# Index
+#
+example "Index" do
+  # Get a list of all your tag_sets
+  tag_sets = Ingenia::TagSet.all
+  puts "got #{tag_sets.length} tag_sets".green
+
+  # Get the first tag_set
+  @test_tag_set = tag_sets.first
+
+  puts "\n First TagSet: ".green
+  puts "#{@test_tag_set}".green
+
+  @test_tag_set_id = @test_tag_set['id']
+  @test_tag_set_name = @test_tag_set['name']
+end
+
+
+##
+# Show
+#
+example "Show" do
+  # Get the updated tag_set, including it's text
+  @test_tag_set = Ingenia::TagSet.get(@test_tag_set_id)
+  puts "\n updated tag_set:"
+  puts "#{@test_tag_set}".green
+end
+
+
+##
+# Update
+# 
+example "Update" do
+  # Update its text
+  response = Ingenia::TagSet.update(@test_tag_set_id, :name => "updated tag_set name new")
+  puts "#{response}".green
+end
+
+
+##
+# Destroy
+#
+example "Destroy" do
+  # Remove this new tag_set
+  response =  Ingenia::TagSet.destroy(@new_test_tag_set['id'])
+  puts "#{response}".green
+end
+

data/examples/tags.rb

@@ -0,0 +1,80 @@
+require './helper'
+
+##
+# Run a full set of API calls on tags
+##
+
+
+#
+# Setup
+#
+# Set API key to the test user for this gem
+require 'ingenia_api'
+#local
+Ingenia::Api.api_key = "API_KEY"
+Ingenia::Api.version = 2.0
+
+
+##
+# Create
+#
+example "Create" do
+  # Get your tag_set
+  @tag_set = Ingenia::TagSet.all.first
+
+  # Create a new tag
+  @new_test_tag = Ingenia::Tag.create(:name => "new tag", :tag_set_id => @tag_set['id'])
+  puts "\n created a new tag:"
+  puts "#{@new_test_tag}".green
+end
+
+
+##
+# Index
+#
+example "Index" do
+  # Get a list of all your tags
+  tags = Ingenia::Tag.all
+  puts "got #{tags.length} tags".green
+
+  # Get the first tag
+  @test_tag = tags.first
+
+  puts "\n First Tag: ".green
+  puts "#{@test_tag}".green
+
+  @test_tag_id = @test_tag['id']
+  @test_tag_name = @test_tag['name']
+end
+
+
+##
+# Show
+#
+example "Show" do
+  # Get the updated tag, including it's text
+  @test_tag = Ingenia::Tag.get(@test_tag_id)
+  puts "\n updated tag:"
+  puts "#{@test_tag}".green
+end
+
+
+##
+# Update
+# 
+example "Update" do
+  # Update its text
+  response = Ingenia::Tag.update(@test_tag_id, :name => "updated tag name new", :description => "this is a testing tag", :tag_set_id => @tag_set['id'])
+  puts "#{response}".green
+end
+
+
+##
+# Destroy
+#
+example "Destroy" do
+  # Remove this new tag
+  response =  Ingenia::Tag.destroy(@new_test_tag['id'])
+  puts "#{response}".green
+end
+

data/examples/train_classify_similar_to.rb

@@ -0,0 +1,42 @@
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'yaml'
+require 'ingenia_api'
+
+def demo(name)
+  puts "\n\n"
+  puts "#\n# #{name}\n#"
+
+  output = yield
+
+  puts "output:#{output.to_yaml}"
+end
+
+def main
+  Ingenia::Api.api_key = "API_KEY"
+  
+  # Classify some text
+  demo "classify" do
+    Ingenia::Api.classify "What kind of cheese is the best cheese?"
+  end
+
+  # Train text onto the default tagset
+  demo "train simple" do
+    Ingenia::Api.train "I like cheeses", [ 'food', 'preference', 'cheese' ]
+  end
+
+  # Train into two specific tagsets
+  demo "train complex" do
+    Ingenia::Api.train "Is it safe to eat cheese from goats?", { :Cookery => [ 'cheese', 'safety' ], :post_type => [ 'question' ] }
+  end
+
+  demo "find items similar to your first item" do
+    first_item = Ingenia::Item.all.first
+
+    puts Ingenia::Api.similar_to(:id => first_item['id'])
+  end
+
+end
+
+main if $0 == __FILE__

data/ingenia-api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ingenia_api'
+  gem.authors       = ['Retechnica Team']
+  gem.email         = %w(ingenia-devs@retechnica.com)
+  gem.summary       = 'A Ruby API client for Ingenia'
+  gem.description   = 'A Ruby API client for Ingenia'
+  gem.homepage      = 'http://www.ingeniapi.com'
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = %w(lib)
+  gem.version       = '1.0.6'
+
+  gem.add_runtime_dependency 'rest-client', '>= 1.8.0'
+  gem.add_runtime_dependency 'json', '>= 1.8.3'
+  gem.add_runtime_dependency 'colorize',  '>= 0.7.7'
+
+  gem.add_development_dependency 'rspec', '>= 3.3.0'
+  gem.add_development_dependency 'webmock', '>= 1.21.0'
+end

data/lib/ingenia_api.rb

@@ -0,0 +1,126 @@
+
+require 'restclient'
+require 'json'
+
+require 'ostruct'
+
+require 'ingenia_api/remote'
+require 'ingenia_api/item'
+require 'ingenia_api/html_extractor'
+require 'ingenia_api/tag'
+require 'ingenia_api/tag_set'
+require 'ingenia_api/bundle'
+
+module Ingenia
+  module Api
+
+    extend self
+
+    API_KNOWN_PARAMS = %w( limit text )
+
+    class CallFailed < StandardError
+      def initialize(output)
+        prefix = output['status']
+        message = output['message']
+        super "#{prefix}: #{message}"
+      end
+    end
+
+    # Status of your app
+    def status
+      debug { "status" }
+      verify_response { Remote.get('/status', :api_key => api_key ) }
+    end
+
+    # Classify some text
+    def classify(text)
+      debug { "classify" }
+      verify_response { Remote.post('/classify', :api_key => api_key, :text => text) }
+    end
+
+    # Deprecated train action, now creates an item
+    def train(text, tags = {})
+      debug { "train" }
+      if tags.is_a? Array
+        Item.create(:json => { :text => text, :tags => tags })
+
+      elsif tags.is_a? Hash
+        Item.create(:json => { :text => text, :tag_sets => tags })
+
+      else
+        raise "Ingenia::Api.train(text, tags) must be called with tags argument as either an Array or a Hash"
+      end
+    end
+
+    # Find similar items
+    def similar_to( params = {} )
+      debug { "similar_to" }
+
+      initialize_params params
+
+      if params.has_key? :text
+        verify_response { Remote.post("/similar_to_text", @params ) }
+      elsif params.has_key? :tag_ids
+        verify_response { Remote.get("/similar_to_tags", @params ) }
+      end
+    end
+
+    # Summarize some text
+    def summarize(params = {})
+      debug { "summarize" }
+      initialize_params params
+
+      verify_response { Remote.post("/summarise", @params ) }
+    end
+
+    def trained_tags
+      debug { "trained_tags" }
+      verify_response { Remote.get('/learnt_tags', :api_key => api_key) }
+    end
+
+    def endpoint=(ep)
+      debug { "endpoint=#{Remote.endpoint}" }
+      Remote.endpoint = ep
+    end
+
+    def version=(v)
+      debug { "version=#{Remote.version}" }
+      Remote.version = v
+    end
+
+    def api_key=(k)
+      debug { "api_key=#{k}" }
+      @api_key = k
+    end
+
+    def api_key
+      raise 'Ingenia::Api.api_key not set' if @api_key.nil?
+      @api_key
+    end
+
+    def debug=(dbg)
+      @debug = dbg
+      debug { "debug is on" }
+    end
+
+    def verify_response
+      output = yield
+
+      return output['data'] unless output['data'].nil?
+
+      raise CallFailed.new( output )
+    end
+
+    private
+
+
+      def self.initialize_params( params = {} )
+        @params = { :api_key => Ingenia::Api.api_key }.merge!(params)
+      end
+
+      def debug
+        puts "Ingenia::Api.debug: #{yield}" if @debug
+      end
+
+  end
+end