semantics3 0.01

data/.gitignore

@@ -0,0 +1,3 @@
+test/
+*.gem
+*.swp

data/Changes

@@ -0,0 +1,5 @@
+Revision history for semantics3-ruby
+
+0.01    31-01-2013
+        First version, released on an unsuspecting world.
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Semantics3, Inc. https://semantics3.com
+
+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.md

@@ -0,0 +1,185 @@
+# semantics3-ruby
+
+semantics3-ruby is a Ruby client for accessing the Semantics3 Products API, which provides structured information, including pricing histories, for a large number of products.
+See https://www.semantics3.com for more information.
+
+Quickstart guide: https://www.semantics3.com/quickstart
+API documentation can be found at https://www.semantics3.com/docs/
+
+## Installation
+
+semantics3-ruby can be installed through the RubyGem system:
+```
+ gem install semantics3
+```
+To build and install from the latest source:
+```
+ git clone git@github.com:Semantics3/semantics3-ruby.git
+ cd semantics3-ruby
+ gem build semantics3.gemspec
+ gem install semantics3-<VERSION>.gem
+```
+
+## Requirements
+
+* json
+* oauth
+
+## Getting Started
+
+In order to use the client, you must have both an API key and an API secret. To obtain your key and secret, you need to first create an account at
+https://www.semantics3.com/
+You can access your API access credentials from the user dashboard at https://www.semantics3.com/dashboard/applications
+
+### Setup Work
+
+Let's lay the groundwork.
+
+```ruby
+require 'semantics3'
+
+# Your Semantics3 API Credentials
+API_KEY = 'SEM3xxxxxxxxxxxxxxxxxxxxxx'
+API_SECRET = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+
+# Set up a client to talk to the Semantics3 API
+sem3 = Semantics3::Products.new(API_KEY,API_SECRET)
+```
+
+### First Query aka 'Hello World':
+
+Let's make our first query! For this query, we are going to search for all Toshiba products that fall under the category of "Computers and Accessories", whose cat_id is 4992. 
+
+```ruby
+# Build the query
+sem3.products_field( "cat_id", 4992 )
+sem3.products_field( "brand", "Toshiba" )
+
+# Make the query
+productsHash = sem3.get_products()
+
+# View the results of the query
+puts productsHash.to_json
+```
+
+## Examples
+
+The following examples show you how to interface with some of the core functionality of the Semantics3 Products API. For more detailed examples check out the Quickstart guide: https://www.semantics3.com/quickstart
+
+### Explore the Category Tree
+
+In this example we are going to be accessing the categories endpoint. We are going to be specifically exploring the "Computers and Accessories" category, which has a cat_id of 4992. For more details regarding our category tree and associated cat_ids check out our API docs at https://www.semantics3.com/docs
+
+```ruby
+# Build the query
+sem3.categories_field( "cat_id", 4992 )
+
+# Make the query
+categoriesHash = sem3.get_categories()
+
+# View the results of the query
+puts categoriesHash.to_json
+```
+
+### Nested Search Query
+
+You can construct complex queries by just repeatedly calling the products_field() or add() methods. Here is how we translate the following JSON query - '{"cat_id":4992,"brand":"Toshiba","weight":{"gte":1000000,"lt":1500000},"sitedetails":{"name":"newegg.com","latestoffers":{"currency":"USD","price":{"gte":100}}}}'.
+
+This query returns all Toshiba products within a certain weight range narrowed down to just those that retailed recently on newegg.com for >= USD 100.
+
+```ruby
+# Build the query
+sem3.products_field( "cat_id", 4992 )
+sem3.products_field( "brand", "Toshiba" )
+sem3.products_field( "weight", "gte", 1000000 )
+sem3.products_field( "weight", "lt", 1500000 )
+sem3.products_field( "sitedetails", "name", "newegg.com" )
+sem3.products_field( "sitedetails", "latestoffers", "currency", "USD" )
+sem3.products_field( "sitedetails", "latestoffers", "price", "gte", 100 )
+
+# Let's make a modification - say we no longer want the weight attribute
+sem3.remove( "products", "brand", "weight" )
+
+# Let's view the JSON query we just constructed. This is a good starting point to debug, if you are getting incorrect 
+# results for your query
+constructedJson = sem3.get_query_json( "products" )
+puts constructedJson
+
+# Make the query
+productsHash = sem3.get_products
+
+# View the results of the query
+puts productsHash.to_json
+```
+
+### Pagination
+
+Let's now look at doing pagination, continuing from where we stopped previously.
+
+```ruby
+# Goto the next 'page'
+page = 0 
+while (productsHash = sem3.iterate_products) do
+    page = page + 1 
+    puts "Iterating through page: #{page}"
+end
+```
+
+### Explore Price Histories
+
+We shall use the add() method, which allows you to access any of the supported endpoints by just specifiying the name of the endpoint. add( "products", param1, param2, ...) is the equivalent of products_field( param1, param2, ... ), add( "offers", param1, param2, ... ) is the equivalent of offers_field( param1, param2, ...)
+
+For this example, we are going to look at a particular product that is sold by select mercgants and whose price is >= USD 30 and seen after a specific date (specified as a UNIX timestamp).
+
+```ruby
+# Build the query
+sem3.add( "offers", "sem3_id", "4znupRCkN6w2Q4Ke4s6sUC")
+sem3.add( "offers", "seller", ["ATRQ56T3H9TM5","LFleurs","Frys","Walmart"] )
+sem3.add( "offers", "currency", "USD")
+sem3.add( "offers", "price", "gte", 30)
+sem3.add( "offers", "lastrecorded_at", "gte", 1348654600)
+
+# Make the query
+offersHash = sem3.get_offers
+#Alternatively we could also do
+offersHash = sem3.run_query( "offers" )
+
+# View the results of the query
+puts offersHash.to_json
+```
+
+## Contributing
+
+Use GitHub's standard fork/commit/pull-request cycle.  If you have any questions, email <support@semantics3.com>.
+
+## Author
+
+* Sivamani VARUN <varun@semantics3.com>
+
+## Copyright
+
+Copyright (c) 2013 Semantics3 Inc.
+
+## License
+
+    The "MIT" License
+    
+    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/examples/example.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'semantics3'
+#
+################################################################################
+# Simple test script to showcase use of the semantics3 Ruby gem to interface
+# with the Semantics3 Products API.
+# 
+# Quickstart guide: https://semantics3.com/quickstart
+# API Documentation: https://semantics3.com/docs
+#
+# Author: Sivamani VARUN <varun@semantics3.com>
+# Copyright (c) 2013 Semantics3 Inc.
+#
+# The MIT License from http://www.opensource.org/licenses/mit-license.php
+#
+# 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.
+#
+#################################################################################
+
+API_KEY = 'YOUR_SEM3_API_KEY'
+API_SECRET = 'YOU_SEM3_API_SECRET'
+sem3 = Semantics3::Products.new(API_KEY,API_SECRET)
+
+sem3.products_field( "cat_id", 4992 )
+sem3.products_field( "brand", "Toshiba" )
+sem3.products_field( "weight", "gte", 1000000 )
+sem3.products_field( "weight", "lt", 1500000 )
+sem3.products_field( "sitedetails", "name", "newegg.com" )
+sem3.products_field( "sitedetails", "latestoffers", "currency", "USD" )
+sem3.products_field( "sitedetails", "latestoffers", "price", "gte", 100 )
+
+# Let's view the JSON query we just constructed. This is a good starting point to debug, if you are getting incorrect 
+# results for your query
+constructedJson = sem3.get_query_json( "products" )
+puts constructedJson
+
+# Make the query
+productsHash = sem3.get_products
+
+# Iterate throught the result of the pages
+page = 0
+while (productsHash = sem3.iterate_products) do
+    page = page + 1
+    puts "Iterating through page: #{page}"
+end

data/lib/semantics3.rb

@@ -0,0 +1,262 @@
+# Ruby bindings for the Semantics3 APIs
+# Quickstart: https://semantics3.com/quickstart
+# Docs: https://semantics3.com/docs
+#
+# Author: Sivamani Varun (varun@semantics3.com)
+# Copyright 2013 Semantics3 Inc., see LICENSE
+
+require 'rubygems'
+require 'oauth'
+require 'uri'
+require 'json'
+
+module Semantics3
+    @auth={}
+
+    class Base
+        def initialize(api_key,api_secret)
+            @api_key = api_key
+            @api_secret = api_secret
+
+            raise Error.new('API Credentials Missing','You did not supply an api_key. Please sign up at https://semantics3.com/ to obtain your api_key.','api_key') if api_key == ''
+            raise Error.new('API Credentials Missing','You did not supply an api_secret. Please sign up at https://semantics3.com/ to obtain your api_secret.','api_secret') if api_secret == ''
+
+            consumer = OAuth::Consumer.new(@api_key, @api_secret)
+            @auth = OAuth::AccessToken.new(consumer)
+        end
+
+        private
+
+        #returns a value
+        def _make_request(endpoint, params)
+            url = 'https://api.semantics3.com/v1/' + endpoint + '?q=' + URI.escape(params)
+
+            #puts "url = #{url}"
+            response = @auth.get(url)
+
+            #-- Response.code - TBD
+            JSON.parse response.body
+        end
+
+    end
+
+    class Products < Base
+        @@data_query = {}
+        @@query_result = {}
+
+        MAX_LIMIT = 10
+
+        #Offers
+
+        def offers_field(*fields)
+            add("offers",*fields)
+        end
+
+        def get_offers 
+            run_query("offers")
+        end
+
+        #Categories
+            
+        def categories_field(*fields)
+            add("categories",*fields)
+        end
+        
+        def get_categories
+            run_query("categories")
+        end
+        
+        #Products
+        
+        def products_field(*fields)
+            add("products",*fields)
+        end
+        
+        def get_products
+            run_query("products")
+        end
+        
+        def all_products
+            if not @@query_result.has_key?(results)
+                raise Error.new('Undefined Query','Query result is undefined. You need to run a query first.')
+            end
+            @@query_result['results']  
+        end
+
+        def iterate_products
+            limit = MAX_LIMIT
+            prodRef = @@data_query['products']
+
+            if (not ( @@query_result.has_key?('total_results_count') ) ) or ( @@query_result['offset'] >= @@query_result['total_results_count'] )
+                return
+            end 
+
+            if prodRef.has_key?('limit')
+                limit = prodRef['limit']
+            end
+
+            if not prodRef.has_key?('offset')
+                prodRef['offset'] = limit
+            else
+                prodRef['offset'] = prodRef['offset'] + limit
+            end
+
+            get_products()
+        end
+
+        #General
+
+        def add(endpoint,*fields)
+
+            #-- If not defined endpoint, throw error
+            if not ( endpoint.kind_of? String and endpoint != '')
+                raise Error.new('Undefined Endpoint','Query Endpoint was not defined. You need to provide one. Eg: products','endpoint')
+            end
+
+            if not @@data_query.has_key?(endpoint)
+                @@data_query[endpoint] = {}
+            end
+
+            prodRef = @@data_query[endpoint]
+
+            for i in 1..(fields.length - 1)
+                if not prodRef.has_key?(fields[i-1])
+                    prodRef[fields[i-1]] = {}
+                end
+                if i != (fields.length - 1)
+                    prodRef = prodRef[fields[i-1]] 
+                else
+                    prodRef[ fields[i-1] ] = fields[i]
+                end
+            end
+
+            #-- To be removed
+            #puts @@data_query.inspect
+
+        end
+
+        def remove(endpoint,*fields)
+
+            #-- If not defined endpoint, throw error
+            if not ( endpoint.kind_of? String and endpoint != '')
+                raise Error.new('Undefined Endpoint','Query Endpoint was not defined. You need to provide one. Eg: products','endpoint')
+            end
+
+            valid = 0
+            prodRef = {}
+            arrayCt = 0
+
+            if @@data_query.has_key?(endpoint)
+                prodRef = data_query[endpoint]
+                arrayCt = fields.length-1
+                valid = 1
+
+                for i in 0..(arrayCt-1)
+                    if prodRef.has_key?(fields[i])
+                        prodRef = prodRef[ fields[i] ]
+                        prodRef[ fields[i-1] ] = {}
+                    else
+                        valid = 0
+                    end
+                end
+            end
+
+            if valid == 1
+                prodRef.delete(fields[arrayCt])
+            else
+                #-- Throw error
+                raise Error.new('Undefined Endpoint','Query Endpoint was not defined. You need to provide one. Eg: products', 'endpoint')
+            end
+                
+            #-- To be removed
+            #puts @@data_query.inspect
+
+        end
+
+        def get_query(endpoint)
+            if not @@data_query.has_key?(endpoint)
+                raise Error.new('Undefined Endpoint','Query Endpoint was not defined. You need to provide one. Eg: products', 'endpoint')
+            end
+            @@data_query[endpoint]
+        end
+
+        def get_query_json(endpoint)
+            if not @@data_query.has_key?(endpoint)
+                raise Error.new('Undefined Endpoint','Query Endpoint was not defined. You need to provide one. Eg: products', 'endpoint')
+            end
+            @@data_query[endpoint].to_json
+        end
+
+        def get_results
+            @@query_result
+        end
+        
+        def get_results_json
+            @@query_result.to_json
+        end
+
+        def clear
+            @@data_query={}
+            @@query_result={}
+        end
+
+        def run_query(endpoint,*params)
+
+            #-- If not defined endpoint, throw error
+            if not ( endpoint.kind_of? String and endpoint != '')
+                raise Error.new('Undefined Endpoint','Query Endpoint was not defined. You need to provide one. Eg: products','endpoint')
+            end
+
+            data = params[0]
+
+            if data == nil
+                @@query_result = _make_request(endpoint,@@data_query[endpoint].to_json)
+            else
+                if not data.is_a?(Hash) and not data.is_a?(String)
+                    #-- Throw error - neither string nor hash
+                    raise Error.new('Invalid Input','You submitted an invalid input. Input has to be either JSON string or hash')
+                else
+                    #-- Data is Hash ref. Great just send it.
+                    if data.is_a?(Hash)
+                        @@query_result = _make_request(endpoint,data.to_json)
+                    #-- Data is string
+                    elsif data.is_a?(String)
+                        #-- Check if it's valid JSON
+                        if JSON.is_json?(data)
+                            @@query_result = _make_request(endpoint,data)
+                        else
+                            raise Error.new('Invalid Input','You submitted an invalid JSON query string')
+                        end
+                    end
+                end
+            end
+            @@query_result
+        end
+
+    end
+
+    class Error < StandardError
+        attr_reader :type
+        attr_reader :message
+        attr_reader :param
+
+        def initialize(type=nil, message=nil, param=nil)
+            @message = 'Error: ' + type + ' Message: ' + message
+            @message += ' Failed at parameter: ' + param if not param.nil?
+        end
+    end
+
+end
+
+module JSON
+    def self.is_json?(foo)
+        begin
+            return false unless foo.is_a?(String)
+            JSON.parse(foo).all?
+        rescue JSON::ParserError
+            false
+        end 
+    end
+end
+
+

data/semantics3.gemspec

@@ -0,0 +1,18 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+spec = Gem::Specification.new do |s|
+  s.name = 'semantics3'
+  s.version = '0.01'
+  s.summary = 'Ruby bindings for the Semantics3 API'
+  s.description = 'Get access to a constantly updated database of product and price ifnormations. See https://semantics3.com/ for more information.'
+  s.authors = ['Sivamani Varun']
+  s.email = ['varun@semantics3.com']
+  s.homepage = 'https://semantics3.com'
+  s.require_paths = %w{lib}
+
+  s.add_dependency('json', '~> 1.7.0')
+  s.add_dependency('oauth', '~> 0.4.6')
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: semantics3
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.01"
+platform: ruby
+authors: 
+- Sivamani Varun
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 7
+        - 0
+        version: 1.7.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        - 6
+        version: 0.4.6
+  type: :runtime
+  version_requirements: *id002
+description: Get access to a constantly updated database of product and price ifnormations. See https://semantics3.com/ for more information.
+email: 
+- varun@semantics3.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Changes
+- Gemfile
+- LICENSE
+- README.md
+- examples/example.rb
+- lib/semantics3.rb
+- semantics3.gemspec
+homepage: https://semantics3.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the Semantics3 API
+test_files: []
+