algoliasearch 1.0.0

data/lib/algolia/protocol.rb

@@ -0,0 +1,92 @@
+require 'cgi'
+
+module Algolia
+  # A module which encapsulates the specifics of Algolia's REST API.
+  module Protocol
+
+    # Basics
+ 
+    # The version of the REST API implemented by this module.
+    VERSION         = 1
+
+    # HTTP Headers
+    # ----------------------------------------
+
+    # The HTTP header used for passing your application ID to the
+    # Algolia API.
+    HEADER_APP_ID   = "X-Algolia-Application-Id"
+
+    # The HTTP header used for passing your API key to the
+    # Algolia API.
+    HEADER_API_KEY  = "X-Algolia-API-Key"
+    
+    # HTTP ERROR CODES
+    # ----------------------------------------
+
+    ERROR_TIMEOUT = 124
+    ERROR_UNAVAILABLE = 503
+
+    # URI Helpers
+    # ----------------------------------------
+
+    # Construct a uri to list available indexes
+    def Protocol.indexes_uri      
+      "/#{VERSION}/indexes"
+    end
+
+    # Construct a uri referencing a given Algolia index
+    def Protocol.index_uri(index)
+      "/#{VERSION}/indexes/#{index}"
+    end
+
+    def Protocol.batch_uri(index)
+      "/#{VERSION}/indexes/#{index}/batch"
+    end
+    
+    def Protocol.task_uri(index, task_id)
+      "#{index_uri(index)}/task/#{task_id}"
+    end
+    
+    def Protocol.object_uri(index, object_id, params = {})
+      params = params.nil? || params.size == 0 ? "" : "?#{to_query(params)}"
+      "#{index_uri(index)}/#{object_id}#{params}"
+    end
+
+    def Protocol.search_uri(index, query, params = {})
+      params = params.nil? || params.size == 0 ? "" : "&#{to_query(params)}"
+      "#{index_uri(index)}?query=#{CGI.escape(query)}&#{params}"
+    end
+
+    def Protocol.partial_object_uri(index, object_id)
+      "#{index_uri(index)}/#{object_id}/partial"
+    end
+    
+    def Protocol.settings_uri(index)
+      "#{index_uri(index)}/settings"
+    end
+    
+    def Protocol.keys_uri
+      "/#{VERSION}/keys"
+    end
+
+    def Protocol.key_uri(key)
+      "/#{VERSION}/keys/#{key}"
+    end
+
+    def Protocol.index_key_uri(index, key)
+      "#{index_uri(index)}/keys/#{key}"
+    end
+
+    def Protocol.index_keys_uri(index)
+      "#{index_uri(index)}/keys"
+    end
+
+    private
+    def Protocol.to_query(params)
+      params.map do |k, v|
+        "#{CGI.escape(k)}=#{CGI.escape(v.to_s)}"
+      end.join('&')
+    end
+    
+  end
+end

data/lib/algoliasearch.rb

@@ -0,0 +1,18 @@
+## ----------------------------------------------------------------------
+##
+## Ruby client for algolia.com
+## A quick library for playing with algolia.com's REST API for object storage.
+## Thanks to Sylvain Utard for the initial version of the library (sylvain.utard@gmail.com)
+## ----------------------------------------------------------------------
+require "rubygems"
+require "bundler/setup"
+
+require 'json'
+require 'curb'
+require 'date'
+require 'cgi'
+
+cwd = Pathname(__FILE__).dirname
+$:.unshift(cwd.to_s) unless $:.include?(cwd.to_s) || $:.include?(cwd.expand_path.to_s)
+
+require 'algolia/index'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: algoliasearch
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Algolia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: shoulda-context
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id009
+description: A simple Ruby client for the algolia.com REST API
+email: contact@algolia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- contacts.json
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- algoliasearch.gemspec
+- lib/algolia/client.rb
+- lib/algolia/error.rb
+- lib/algolia/index.rb
+- lib/algolia/protocol.rb
+- lib/algoliasearch.rb
+homepage: http://github.com/algolia/algoliasearch-client-ruby
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple Ruby client for the algolia.com REST API
+test_files: []
+