ingenia_api 1.0.6

data/lib/ingenia_api/bundle.rb

@@ -0,0 +1,62 @@
+class Ingenia::Bundle
+  include Ingenia::Api
+
+  PATH = '/bundles'
+
+  # These are known request params, all other params will go inside the json object
+  BUNDLE_KNOWN_PARAMS = %i{ full_text offset limit }
+
+  # Get a single bundle by id
+  def self.get id, params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get "#{PATH}/#{id}", @params
+    end
+  end
+
+  # Create a new bundle
+  def self.create params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.post(PATH, @params )
+    end
+  end
+
+  # Update an existing bundle
+  def self.update id, params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.put("#{PATH}/#{id}", @params )
+    end
+  end
+
+
+  # Index your bundles
+  def self.all params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get(PATH, @params )
+    end
+  end
+
+  def self.destroy id
+    Ingenia::Api.verify_response do
+      Remote.delete("#{PATH}/#{id}", :params => { :api_key => Ingenia::Api.api_key} )
+    end
+  end
+
+  private
+    def self.initialize_params( params = {} )
+      # break params down into for json object and for request
+      request_params = params.select{ |k,v| BUNDLE_KNOWN_PARAMS.include?(k) }
+      json_params = params.select{ |k,v| not BUNDLE_KNOWN_PARAMS.include?(k) }
+
+      @params = { :api_key => Ingenia::Api.api_key }
+      @params.merge!( { :json => json_params.to_json } ) unless json_params.empty? 
+      @params.merge! request_params
+    end
+end

data/lib/ingenia_api/html_extractor.rb

@@ -0,0 +1,24 @@
+class Ingenia::HtmlExtractor
+  class MissingUrl < StandardError; end
+
+  include Ingenia::Api
+
+  PATH = '/html_extractor'
+
+  # Fetch the url html
+  def self.fetch( params = {} )
+    raise(MissingUrl) unless params.has_key?(:url)
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get( "#{PATH}/fetch", @params )
+    end
+  end
+
+
+  private
+    def self.initialize_params( params = {} )
+      @params = params.clone
+      @params.merge!( { :api_key => Ingenia::Api.api_key } )
+    end
+end

data/lib/ingenia_api/item.rb

@@ -0,0 +1,99 @@
+class Ingenia::Item
+  include Ingenia::Api
+
+  PATH = '/items'
+
+  # Get a single item by id
+  def self.get( id, params = {} )
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get( "#{PATH}/#{id}", @params )
+    end
+  end
+
+  ##
+  # Create a new item
+  #
+  #
+  def self.create( params = {} )
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.post( PATH, @params )
+    end
+  end
+
+  ##
+  # Find or create a new item by text
+  #
+  #
+  def self.find_or_create_by_text( params = {} )
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.post( PATH, @params )
+    end
+  end
+
+  #
+  # Update an existing item
+  #
+  def self.update( id, params = {} )
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.put("#{PATH}/#{id}", @params )
+    end
+  end
+
+  #
+  # Scan your items
+  #
+  def self.scan params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get( "#{PATH}/scan", @params )
+    end
+  end
+
+  #
+  # Index your items
+  #
+  def self.all params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get( PATH, @params )
+    end
+  end
+
+  #
+  # Destroy an item
+  #
+  def self.destroy id
+    Ingenia::Api.verify_response do
+      Remote.delete("#{PATH}/#{id}", :params => { :api_key => Ingenia::Api.api_key} )
+    end
+  end
+
+  #
+  # Get similar items
+  #
+  def self.similar_to(id, mode='auto', params={})
+    initialize_params params.merge(mode: mode.to_s)
+
+    Ingenia::Api.verify_response do
+      Remote.get("#{PATH}/#{id}/similar_to", @params)
+    end
+  end
+
+  private
+    def self.initialize_params( params = {} )
+      @params = params.clone
+
+      @params[:json] = @params[:json].to_json if @params[:json]
+      @params.merge!( { :api_key => Ingenia::Api.api_key } )
+    end
+end

data/lib/ingenia_api/remote.rb

@@ -0,0 +1,131 @@
+
+module Ingenia
+module Api
+
+  module Remote
+    ENDPOINT = 'api.ingeniapi.com'
+    DEFAULT_VERSION = 2.0
+
+    MAX_ATTEMPTS = 3
+
+    attr_reader :port
+
+    extend self
+
+    def get(path, opts = {})
+      check_params opts
+
+      handle_request do
+        uri = build_uri(path, opts)
+        JSON.parse( RestClient.get uri.to_s, :params => opts )
+      end
+    end
+
+
+    def post(path, opts = {})
+      check_params opts
+
+      handle_request do
+        uri = build_uri(path, opts)
+        JSON.parse( RestClient.post uri.to_s, opts )
+      end
+    end
+
+    def put(path, opts = {})
+      check_params opts
+
+      handle_request do
+        uri = build_uri(path, opts)
+        JSON.parse( RestClient.put uri.to_s, opts )
+      end
+    end
+
+    def delete(path, opts = {})
+      handle_request do
+        uri = build_uri(path, opts)
+        JSON.parse( RestClient.delete uri.to_s, opts )
+      end
+    end
+
+    def endpoint=(str)
+      if str[ ':' ]
+        parts = str.split(':')
+        @endpoint = parts[0]
+        @port     = parts[1].to_i
+        return str
+      end
+
+      @endpoint = str
+    end
+
+    def version=(str)
+      # safety checking on version number
+      if str.class == String
+        raise 'Please set version to a float, eg 2.0'
+      end
+      @version = str
+    end
+
+    def endpoint
+      @endpoint || ENDPOINT
+    end 
+
+    def version_string
+      "v#{version.round}"
+    end
+
+    def version
+      @version || DEFAULT_VERSION
+    end 
+
+
+    private
+
+      def check_params param_hash
+        raise "missing API key" if (not param_hash.has_key?(:api_key)) || param_hash[:api_key].nil? || param_hash[:api_key].length == 0
+      end
+
+      def handle_request
+        loop do # until successful
+          begin
+            return yield
+
+          rescue RestClient::Conflict => e
+            return JSON.parse e.response
+            
+          rescue RestClient::RequestFailed => e
+            if e.response.nil? || e.response.code != 429 # throttling
+              return { 'status' => 'error', 'message' => e.to_s }
+            end
+
+          rescue RestClient::BadRequest => e
+            if e.response.nil?
+              return { 'status' => 'error', 'message' => e.to_s }
+            else
+              return JSON.parse e.response
+            end
+
+          rescue RestClient::UnprocessableEntity => e
+            return JSON.parse e.response
+
+          rescue JSON::ParserError => e
+            # puts e.inspect
+
+            return { 'status' => 'error', 'message' => e.to_s }
+
+          end
+
+        end
+      end
+
+      def build_uri(path, opts = {})
+        path = "/#{version_string}" + path unless version.eql?(1.0)
+
+        url  = URI::HTTP.build( :host => endpoint, :path => path )
+        url.port = port if port
+
+        url
+      end
+    end
+  end
+end

data/lib/ingenia_api/tag.rb

@@ -0,0 +1,72 @@
+class Ingenia::Tag
+  include Ingenia::Api
+
+  PATH             = '/tags'
+
+  # These are known request params, all other params will go inside the json object
+  TAG_KNOWN_PARAMS = %i{ full_text offset limit tag_ids }
+
+  # Get a single tag by id
+  def self.get id, params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get "#{PATH}/#{id}", @params
+    end
+  end
+
+  # Create a new tag
+  def self.create params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.post(PATH, @params)
+    end
+  end
+
+  # Update an existing tag
+  def self.update id, params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.put("#{PATH}/#{id}", @params)
+    end
+  end
+
+  # Update an existing tag
+  def self.merge id, params = {}
+    # dirty hack
+    params[:tag_ids] = params[:tag_ids].to_json
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.post("#{PATH}/#{id}/merge", @params)
+    end
+  end
+
+  # Index your tags
+  def self.all params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get(PATH, @params)
+    end
+  end
+
+  def self.destroy id
+    Ingenia::Api.verify_response do
+      Remote.delete("#{PATH}/#{id}", :params => { :api_key => Ingenia::Api.api_key })
+    end
+  end
+
+  private
+  def self.initialize_params(params = {})
+    # break params down into for json object and for request
+    request_params = params.select { |k, v| TAG_KNOWN_PARAMS.include?(k) }
+    json_params    = params.select { |k, v| not TAG_KNOWN_PARAMS.include?(k) }
+
+    @params = { :api_key => Ingenia::Api.api_key }
+    @params.merge!({ :json => json_params.to_json }) unless json_params.empty?
+    @params.merge! request_params
+  end
+end

data/lib/ingenia_api/tag_set.rb

@@ -0,0 +1,59 @@
+class Ingenia::TagSet
+  include Ingenia::Api
+
+  PATH = '/tag_sets'
+  TAG_SET_KNOWN_PARAMS = %i{ offset limit } 
+
+  # Get a single tag_set by id
+  def self.get id
+    Ingenia::Api.verify_response do
+      Remote.get "#{PATH}/#{id}", :api_key => Ingenia::Api.api_key
+    end
+  end
+
+  # Create a new tag_set
+  def self.create params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.post(PATH, @params )
+    end
+  end
+
+  # Update an existing tag_set
+  def self.update id, params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.put("#{PATH}/#{id}", @params )
+    end
+  end
+
+  # Index your tag_sets
+  def self.all params = {}
+    initialize_params params
+
+    Ingenia::Api.verify_response do
+      Remote.get(PATH, @params )
+    end
+  end
+
+  def self.destroy id
+    Ingenia::Api.verify_response do
+      Remote.delete("#{PATH}/#{id}", :params => { :api_key => Ingenia::Api.api_key} )
+    end
+  end
+
+
+  private
+    def self.initialize_params( params = {} )
+      # break params down into those for json object and those for request
+      request_params = params.select{ |k,v| TAG_SET_KNOWN_PARAMS.include?(k) }
+      json_params = params.select{ |k,v| not TAG_SET_KNOWN_PARAMS.include?(k) }
+
+
+      @params = { :api_key => Ingenia::Api.api_key }
+      @params.merge!( { :json => json_params.to_json } ) unless json_params.empty? 
+      @params.merge! request_params
+    end
+end