srchio 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NThhN2Y1YTU2ODUwODdlNGQ0YzY3ZDcyYzU2OWQzOGIzNjM4OTQxNw==
+  data.tar.gz: !binary |-
+    ZGY1N2M4NWI3MWZmMGFlNDk1ZGMxYzIxNTljNmUxMWRkYjg0OWRjNg==
+SHA512:
+  metadata.gz: !binary |-
+    M2VkZDM5OWQ1NzRiYzMwN2RmM2FkMzhkYTU1NmY5Yzk1MjJkZjk3NmJlZWUy
+    ZjY2NmY3ZGJmOTY3ZGU4ZTgzZGIxYTFkOTBkYWE4Njk2ZTIzZjg0NTkwMmJk
+    NjRmYzdhNGVmNmQ1ODQ5ZjYwZDZlNGQ1ZGY4MTViZGIxMDA3YTg=
+  data.tar.gz: !binary |-
+    YmQ4Mjg3MWZmNzUyODM4Yzk5YWEyYTQxODhiZGE3NDg3NjQyZGQyYTJlODhj
+    YWY4ODQ0MGE2YTcxYjVjNjNjNDc1Y2YzZGNkNWMxMWJmYjMxYjdmODU1NDZi
+    ODFhMWZiMGUxMTMzZDZjMzIzYzQ3MGQ3YTdhOGJkZmIwZDllNWU=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'httparty'

data/README.md

@@ -0,0 +1,41 @@
+## Introduction
+
+This is the ruby wrapper for [srch.io](http://srch.io).  We're a platform as a service providing an easy developer-friendly way to add search to your application or site!
+
+## Setup 
+
+Add the gem to your Gemfile:
+
+<pre><code>gem 'srchio'</code></pre>
+
+Run <code>bundle install</code>.
+
+Log in to your account on [srch.io](http://srch.io) and create a new Searcher.  You'll need two pieces of information to use the gem: your api token, and the id of your searcher.  You can get your API Token on your [Account page](https://srch.io/account), and the ID of your searcher from that searcher's page, linked from [Your Searchers](https://srch.io/searchers).
+
+If you're using it in Rails, you'll probably want to create an initializer that looks something like this:
+
+<pre><code>require 'srchio'
+Srchio::Client.api_token = ENV['SRCH_API_TOKEN']
+Srchio::Client.searcher_id = ENV['SRCH_ID']</code></pre>
+
+## Usage
+
+Once you've configured things, you'll want to use it!
+
+<pre><code>client = Srchio::Client.new
+
+client.add_document(
+  url: "http://srch.io",
+  title: "srch.io - home",
+  body: "srch.io is a fun way to add search to your app.",
+  remote_id: 1,
+  tags: ['fun', 'api', 'awesome']
+)
+
+client.search(query: "fun")</code></pre>
+
+If you need to delete a document, you can do it either with your remote_id or the index_id returned in the add_document call:
+
+<pre><code>client.destroy_document(remote_id: 1)</code></pre>
+
+If you have any issues, please create a [Github Issue](https://github.com/railsmachine/srchio/issues).  Thanks for using srch.io!

data/lib/srchio.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require 'srchio/client'
+require 'srchio/response'
+require 'srchio/result'
+require 'srchio/version'
+
+module Srchio
+  
+end

data/lib/srchio/client.rb

@@ -0,0 +1,132 @@
+module Srchio
+  class Client
+    include HTTParty
+
+    attr_accessor :searcher_id, :api_token, :api_domain, :api_protocol
+
+    base_uri "https://srch.io/"
+
+    def self.api_protocol
+      @@api_protocol ||= "https"
+    end
+
+    def self.api_protocol=(p)
+      @@api_protocol = p
+      update_base_uri
+    end
+
+    def self.api_domain
+      @@api_domain ||= "srch.io"
+    end
+
+    def self.api_domain=(domain)
+      @@api_domain = domain
+      update_base_uri
+    end
+
+    def self.api_token
+      @@api_token || nil
+    end
+
+    def self.api_token=(token)
+      @@api_token = token
+      update_default_headers
+      true
+    end
+
+    def self.searcher_id
+      @@searcher_id || nil
+    end
+
+    def self.searcher_id=(id)
+      @@searcher_id = id
+      true
+    end
+
+    def self.update_base_uri
+      base_uri = "#{self.api_protocol}://#{self.api_domain}/"
+      true
+    end
+
+    def self.update_default_headers
+      headers 'X_SRCH_API_TOKEN' => self.api_token
+      true
+    end
+
+=begin rdoc
+Create a new Srchio::Client. 
+options:
+* :searcher_id: The ID of the searcher to use for this client.
+* :api_token: This is required if you haven't set it using Srch::Client.api_token=
+* :api_protocol: optional - defaults to https
+* :api_domain: optional - defaults to srch.io
+=end
+    def initialize(opts={})
+      raise ArgumentError, "opts must be a Hash" unless opts.is_a?(Hash)
+      
+      @searcher_id = opts[:searcher_id] || @@searcher_id
+      
+      raise ArgumentError, ":searcher_id must not be nil" if @searcher_id.nil?
+    end
+
+=begin rdoc
+Sends a test request, making sure you're sending the api token correctly
+=end
+    def test
+      Srchio::Response.new(self.class.get("/api/test"))
+    end
+
+=begin rdoc
+Add or update a document in the searcher.
+options:
+* :url: required, the URL for the document
+* :title: required, the title of the document
+* :body: required, the body of the document
+* :tags: optional, the list of tags for the document.
+* :remote_id: optional, but recommended, the id of the document in your system.
+=end
+    def add_document(opts={})
+      raise ArgumentError, ":title is required" if opts[:title].nil?
+      raise ArgumentError, ":body is required" if opts[:body].nil?
+      raise ArgumentError, ":url is required" if opts[:url].nil?
+      
+      if opts[:tags].is_a?(Array)
+        opts[:tags] = opts[:tags].join(",")
+      end
+      
+      Srchio::Response.new(self.class.post("/api/searchers/#{searcher_id}/documents", :query => opts))
+    end
+
+=begin rdoc
+Delete a document from the searcher.
+options: One of the following is required.
+* :remote_id: The remote_id you set when adding the document.
+* :index_id: The id returned by the system when you added the document
+=end
+    def destroy_document(opts={})
+      raise ArgumentError if opts[:remote_id].nil? && opts[:index_id].nil?
+      
+      Srchio::Response.new(self.class.delete("/api/searchers/#{searcher_id}/documents", :query => opts))
+    end
+
+=begin rdoc
+Searches your searcher!
+options:
+* :query: A text string to search for.  Searches title, body and tags for this string.
+* :body: A query, searches just the body.
+* :title: A query, searches just the title.
+* :tags: An array of tags to search for.
+* :remote_id: A remote_id to search for.
+* :id: The id of the document you wish to retrieve.
+* :page: The page of results to return.  Defaults to 1.
+* :per_page: How many results to return per page.  Defaults to 25.
+=end
+    def search(opts={})
+      if opts[:query].nil? && opts[:body].nil? && opts[:title].nil? && opts[:tags].nil? && opts[:remote_id].nil? && opts[:id].nil?
+        raise ArgumentError, "Opts must contain at least one of: :query, :body, :title, :tags, :remote_id, :id"
+      end
+      
+      Srchio::Response.new(self.class.get("/api/searchers/#{searcher_id}/search", :query => opts))
+    end
+  end
+end

data/lib/srchio/response.rb

@@ -0,0 +1,26 @@
+module Srchio
+  class Response
+    attr_accessor :success, :error, :results, :pages, :current_page, :previous_page
+    
+    def initialize(response)
+      puts response.body
+      r = response.parsed_response
+      @success = r['success']
+      if r['success'].nil?
+        @success = false
+      end
+      @error = r['error']
+      @pages = r['pages']
+      @current_page = r['current_page']
+      @next_page = r['next_page']
+      @previous_page = r['previous_page']
+      
+      if r['results'].is_a?(Array)
+        @results = []
+        r['results'].each do |result|
+          @results << Srchio::Result.new(result)
+        end
+      end
+    end
+  end
+end

data/lib/srchio/result.rb

@@ -0,0 +1,14 @@
+module Srchio
+  class Result
+    attr_accessor :title, :highlight, :url, :tags, :remote_id, :index_id
+    
+    def initialize(result={})
+      @title = result['title']
+      @highlight = result['highlight']
+      @url = result['url']
+      @tags = result['tags']
+      @remote_id = result['remote_id']
+      @index_id = result['index_id']
+    end
+  end
+end

data/lib/srchio/version.rb

@@ -0,0 +1,3 @@
+module Srchio
+  VERSION = "0.0.1"
+end

data/srchio.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "srchio/version"
+
+Gem::Specification.new do |s|
+  s.name        = "srchio"
+  s.version     = Srchio::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kevin Lawver"]
+  s.email       = ["support@srch.io"]
+  s.licenses    = ["MIT"]
+  s.homepage    = "http://github.com/railsmachine/srchio"
+  s.summary     = %q{The official gem for srch.io! Makes searching fun and easy.}
+  s.description = %q{The official gem and wrapper for the srch.io API. More info @ http://srch.io}
+
+  s.required_ruby_version     = '>= 1.9.3'
+
+  s.add_dependency 'httparty',      ">= 0.12.0"
+
+  s.post_install_message = "Hooray, you've installed srchio! Thanks!"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: srchio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Lawver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: The official gem and wrapper for the srch.io API. More info @ http://srch.io
+email:
+- support@srch.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/srchio.rb
+- lib/srchio/client.rb
+- lib/srchio/response.rb
+- lib/srchio/result.rb
+- lib/srchio/version.rb
+- srchio.gemspec
+homepage: http://github.com/railsmachine/srchio
+licenses:
+- MIT
+metadata: {}
+post_install_message: Hooray, you've installed srchio! Thanks!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: The official gem for srch.io! Makes searching fun and easy.
+test_files: []