s3search 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2f409bf1d5943a4bba14de2d68380fd42de29e5
-  data.tar.gz: fa9aae7844c80c61be5fca34bfbf1d18be16b3f3
+  metadata.gz: 93860ffead9f069dc475c369b5cf87942f1e22c6
+  data.tar.gz: 020a5ed8bd7c10c4d8d6937d4a3d6b8523bdf742
 SHA512:
-  metadata.gz: 17497e746c81e2e54ab2690b64e4a27f8b98cca4f24a79772bbe81044cb70acec9d0c1ad95dc2c5b6e80e9e28917f46d61c0a236bd81588120dd544e5ce75672
-  data.tar.gz: 0d79ac7927201e5a74a407d865c83622b0e072f2ca3f966c0c79a4c24a04f163b6afaba16ab211d636401666e575c97166ec1f9ee940b8d0de3ee0606625f764
+  metadata.gz: 2b3c57cd0b7ad978ad99a93c05cab3bf1863edc52b30c75c0b70ae0f0b38770f892c1dcb8407464da709e375ba83e4b53ce64bd734bfc3e4482652cb0143bfd6
+  data.tar.gz: c3c1ba2c23cb56c446bc790c67d4811291f196809d0e15d247bc303830f1a46cf372bdd38ede0ef2b05a547412823fe3229826196f2a81ab17ad54879b99cf2b

data/HEROKU.md

@@ -0,0 +1,141 @@
+[S3Search](http://addons.heroku.com/s3search) is an [add-on](http://addons.heroku.com) for providing powerful document-based full-text indexing and search to your application.
+
+Adding S3Search to your application will allow you search your documents based upon the actual text within the documents, as well as any metadata fields you assign to them. Yes, that's right! S3Search will index the text inside your documents.
+
+Do you already have documents stored and want to index them and make them searchable? No worries. S3Search works by you sending it a URL to fetch the document content to index, along with a hash of metadata attributes to record against it.  You can them perform powerful queries against that indexed data, based on the rich features of [elasticsearch](http://www.elasticsearch.org).
+
+S3Search is accessible via an API, or HTTP, and currently has a supported client library for Ruby.
+
+## Provisioning the add-on
+
+S3Search can be attached to a Heroku application via the  CLI:
+
+<div class="callout" markdown="1">
+A list of all plans available can be found [here](http://addons.heroku.com/s3search).
+</div>
+
+    :::term
+    $ heroku addons:add s3search
+    -----> Adding s3search to sharp-mountain-4005... done, v18 (free)
+
+Once S3Search has been added a `S3SEARCH_URL` setting will be available in the app configuration and will contain your custom URL to access the newly provisioned S3Search service instance. This can be confirmed using the `heroku config:get` command.
+
+    :::term
+    $ heroku config:get S3SEARCH_URL
+    https://user:pass@us-east-1.s3searchapp.com
+
+After installing S3Search the application should be configured to fully integrate with the add-on.
+
+## Using with Rails 3.x
+
+Ruby on Rails applications will need to add the following entry into their `Gemfile` specifying the S3Search client library.
+
+    :::ruby
+    gem 's3search'
+
+Update application dependencies with bundler.
+
+    :::term
+    $ bundle install
+
+Write some application code to index some documents.
+
+    :::ruby
+    S3Search::Document.create title: 'MyDocument', _content_url: 'https://s3-us-east-1.amazonaws.com/my_bucket/my_document.pdf'
+    S3Search::Document.create name: 'Bob Lob Law', resume_id: 25, _content_url: 'https://s3-us-east-1.amazonaws.com/resumes.mycompany.com/bob.pdf'
+    
+The documents don't even really need to be in S3.
+    
+    :::ruby
+    S3Search::Document.create name: 'Bitcoin Pirate', resume_id: 42, _content_url: 'https://user:pass@authenticatedlocation.com/docs/jenny.pdf'
+    S3Search::Document.create title: 'Bitcoin', author: 'santoshin@gmx.com', tags: ['bitcoin', 'manifesto'], _content_url: 'http://bitcoin.org/bitcoin.pdf'
+
+The documents don't even really need to be documents! You can use S3Search to use its powerful search capability over just your custom metadata.
+
+    :::ruby
+    S3Search::Document.create customer_id: 32, first_name: 'His Holiness', last_name: 'The Dalia Lama', religion: 'Buddhist', twitter_handle: '@DalaiLama'
+    S3Search::Document.create customer_id: 99, first_name: 'George', middle_name: 'R. R.', last_name: 'Martin', job_title: 'Author'
+    
+Now retrieve some documents via the powerful query API.
+
+Search by a single metadata field
+
+    :::ruby
+    results = S3Search::Document.search(title: 'MyDocument')
+    
+Search all metadata fields AND the content of the documents.
+
+    :::ruby
+    results = S3Search::Document.search('bitcoin')
+
+Search only the content of the documents.
+
+    :::ruby
+    results = S3Search::Document.search(_document_content: 'bitcoin')
+ 
+ Boost the search ranking of a certain field.
+ 
+     :::ruby
+     results = S3Search::Document.search('bitcoin', boost: { title: 2.5 })
+
+ Find a single document based on its unique id.
+ 
+     :::ruby
+     document = S3Search::Document.get '833FCA4EEEF2943AC2D8E0'
+
+## Monitoring & Logging
+
+Stats and the current state of S3Search can be displayed via the CLI.
+
+    :::term
+    $ heroku s3search:status
+    documents_indexed: 32842
+    index_size: 640MB
+
+S3Search activity can be observed within the Heroku log-stream.
+
+    :::term
+    $ heroku logs -t | grep 's3search'
+
+## Dashboard
+
+<div class="callout" markdown="1">
+For more information on the features available within the S3Search dashboard please see the docs at [heroku.s3searchapp.com/docs](heroku.s3searchapp.com/docs).
+</div>
+
+The S3Search dashboard allows you to view the current status of your S3Search cluster.
+
+The dashboard can be accessed via the CLI:
+
+    :::term
+    $ heroku addons:open s3search
+    Opening s3search for sharp-mountain-4005…
+
+or by visiting the [Heroku apps web interface](http://heroku.com/myapps) and selecting the application in question. Select S3Search from the Add-ons menu.
+
+## Migrating between plans
+
+<div class="note" markdown="1">Application owners should carefully manage the migration timing to ensure proper application function during the migration process.</div>
+
+Use the `heroku addons:upgrade` command to migrate to a new plan.
+
+    :::term
+    $ heroku addons:upgrade s3search:newplan
+    -----> Upgrading s3search:newplan to sharp-mountain-4005... done, v18 ($49/mo)
+           Your plan has been updated to: s3search:newplan
+
+## Removing the add-on
+
+S3Search can be removed via the CLI.
+
+<div class="warning" markdown="1">This will destroy all metadata and indexes stored in S3Search and cannot be undone! Of course, documents indexed in S3Search but stored elsewhere will remain untouched.</div>
+
+    :::term
+    $ heroku addons:remove s3search
+    -----> Removing s3search from sharp-mountain-4005... done, v20 (free)
+
+Before removing S3Search a data export can be performed by contacting support@s3searchapp.com directly.
+
+## Support
+
+All S3Search support and runtime issues should be submitted via on of the [Heroku Support channels](support-channels). Any non-support related issues or product feedback is welcome at feedback@s3searchapp.com.

data/README.md

@@ -35,7 +35,7 @@ Once S3Search has been added a `S3SEARCH_URL` setting will be available in the a
 
 ```term
     $ heroku config:get S3SEARCH_URL
-    https://user:pass@api.s3searchapp.com
+    https://user:pass@us-east-1.s3searchapp.com
 ```
 
 After installing S3Search the application should be configured to fully integrate with the add-on.

data/integration/search_spec.rb

@@ -8,6 +8,8 @@ describe '/searches' do
       S3Search.delete doc.id
     end
 
+    baseline_query_count = S3Search.query_count
+
     title_a = SecureRandom.hex
     title_b = SecureRandom.hex
     
@@ -21,12 +23,15 @@ describe '/searches' do
 
     a_doc_ids = S3Search.create_many(a_docs).map(&:id)
     b_doc_ids = S3Search.create_many(b_docs).map(&:id)
+    expect(S3Search.query_count).to eq(baseline_query_count + 3)
+
     all_doc_ids = a_doc_ids + b_doc_ids
 
     S3Search.get_all(per_page: 20).each do |doc|
       expect(all_doc_ids).to include(doc.id)
     end
-
+    expect(S3Search.query_count).to eq(baseline_query_count + 5)
+    
     results = S3Search.simple_search "title:#{title_a}", per_page: 4
     expect(results.size).to eq(4)
     results.each do |doc|
@@ -52,19 +57,12 @@ describe '/searches' do
       expect(b_doc_ids).to include(doc.id)
     end
 
-    # begin
-    #   results.each do |result|
-    #     S3Search.delete result.id
-    #   end
-    # end while results.next
-
-    # document = S3Search.create title: 'blah'
-    # expect(document.title).to eq('blah')
-
-    # id = document.id
-
-    # expect(S3Search.get(id).title).to eq('blah')
-
-    # puts S3Search.search 'blah'
+    begin
+      results.each do |result|
+        S3Search.delete result.id
+      end
+    end while results.next
+    
+    expect(S3Search.query_count).to eq(baseline_query_count + 20)
   end
 end

data/lib/s3search/api/stats.rb

@@ -0,0 +1,10 @@
+module S3Search
+  module API
+    module Stats
+
+      def query_count
+        _get("/v1/stats/query_count.json").query_count
+      end
+    end
+  end
+end

data/lib/s3search/client.rb

@@ -5,6 +5,7 @@ require 'hashie'
 require 'logger'
 require 's3search/api/documents'
 require 's3search/api/searches'
+require 's3search/api/stats'
 require 's3search/request_error'
 require 's3search/version'
 
@@ -12,11 +13,12 @@ module S3Search
   class Client
     include S3Search::API::Documents
     include S3Search::API::Searches
+    include S3Search::API::Stats
 
     attr_reader :url, :http, :logger
 
     def initialize
-      @url = ENV['S3SEARCH_URL'] || 'https://api.s3searchapp.com'
+      @url = ENV['S3SEARCH_URL'] || 'https://us-east-1.s3searchapp.com'
       @http = Faraday.new(:url => @url) do |builder|
         builder.response :mashify
         builder.response :json, :content_type => /\bjson$/

data/lib/s3search/version.rb

@@ -1,3 +1,3 @@
 module S3Search
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/acceptance/document_get_all_spec.rb

@@ -4,7 +4,7 @@ describe 'getting all documents' do
   let(:document_jsons) { (1..27).map{ |i| Hashie::Mash.new(id: "id#{i}", _score: 1.0, name: "doc#{i}") } }
     
   def link page, per_page
-    "https://api.s3searchapp.test/v1/documents.json?page=#{page}&per_page=#{per_page}"
+    "https://us-east-1.s3searchapp.test/v1/documents.json?page=#{page}&per_page=#{per_page}"
   end  
 
   it 'takes per_page and page params' do

data/spec/acceptance/search_simple_spec.rb

@@ -3,7 +3,7 @@ require 'active_support/core_ext/hash/deep_merge'
 describe 'search' do
   
   def link id, page, per_page
-    "https://api.s3searchapp.test/v1/searches/abcde.json?page=#{page}&per_page=#{per_page}"
+    "https://us-east-1.s3searchapp.test/v1/searches/abcde.json?page=#{page}&per_page=#{per_page}"
   end
 
   let(:found_documents) { (1..70).map{|i| {id: SecureRandom.hex, name: "doc#{i}", _score: 1.0 / i}}}

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext/object/try'
 
 ENV['S3SEARCH_API_KEY'] = 'api_key'
 ENV['S3SEARCH_API_SECRET'] = 'api_secret'
-ENV['S3SEARCH_URL'] = 'https://@api.s3searchapp.test'
+ENV['S3SEARCH_URL'] = 'https://us-east-1.s3searchapp.test'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -16,7 +16,7 @@ end
 def stub_api_http method, resource, body=nil, &block
   stub_request(
     method,
-    "https://api.s3searchapp.test#{resource}"
+    "https://us-east-1.s3searchapp.test#{resource}"
   ).with(
     body: body.try(:to_json),
     headers: {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3search
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Aitchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,14 +118,17 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- HEROKU.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - integration/document_spec.rb
 - integration/search_spec.rb
+- integration/stats_spec.rb
 - lib/s3search.rb
 - lib/s3search/api/documents.rb
 - lib/s3search/api/searches.rb
+- lib/s3search/api/stats.rb
 - lib/s3search/client.rb
 - lib/s3search/request_error.rb
 - lib/s3search/result_page.rb
@@ -167,6 +170,7 @@ summary: S3Search Ruby API
 test_files:
 - integration/document_spec.rb
 - integration/search_spec.rb
+- integration/stats_spec.rb
 - spec/acceptance/document_create_many_spec.rb
 - spec/acceptance/document_create_spec.rb
 - spec/acceptance/document_delete_spec.rb