siteseeker_normalizer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODRiMzZlNmRkYTA4ZDY5YmQxZWNkODVkZjk5NDIyNjYyMzlmNmZhNw==
-  data.tar.gz: !binary |-
-    NjcyNjZjZDBkMjA1NDBkM2Y0MTQzMjg4MjE3YWFlNGNiOTljOGI1NQ==
+SHA1:
+  metadata.gz: 211d91fe539ec4e33ddebe8336c73252ab3b67a0
+  data.tar.gz: 5dba9516fdc952c5e9b9e1f4a850d0e6db4cb641
 SHA512:
-  metadata.gz: !binary |-
-    YmFiODBjNzVhOTRlM2Y2MzdmZjkxMTVkYTFlZmJjODM0ZjE4ODQ1OTkxZDNk
-    MTQ1YWEzNjY3ZWE1ODA0OTJiYjI5YTk2MWE0NWIzYTNlM2M3ODA4MGEyOTI1
-    ZWUzYzIwMzZhZDEzNzczN2JkOWRlZjBkYjdjZTMxYTk5YzNiNzA=
-  data.tar.gz: !binary |-
-    ODk5Yjc3MTEyZDJlNmVhNzM4ZWVmMmE3NTQwYTg4ZmEyNjVjZmQ3NDRjYmQ2
-    OTE2MjQyMDA1OGE5YjAwM2U1YjA5OTM5OWQwNmQ2ZTI3MTUyMDBjMTc1ZTZl
-    MmU1NWI5NjhhYjA0YTUxOWUyZjM0ZjI2YzdhMjE4N2JjZGU4MTM=
+  metadata.gz: 4189fa5ad8c6245bf92bf4fc8a1beb24bb93da650bbf3326905c43c771d853892f8c56c680ebd876a819e70860c4531b66ba5b3cf626a46a545c88bb9a877c78
+  data.tar.gz: 7b7d752a74009fb6e38640ad05a2b48444b48d1f81d64d78ab6ea249f2043d32928da246d524d6822d2d0594efebe9d87b3ddf3788523d7a76dbc731bdcf8e48

data/README.md

@@ -2,10 +2,10 @@
 
 [![Build Status](https://travis-ci.org/malmostad/siteseeker_normalizer.png)](https://travis-ci.org/malmostad/siteseeker_normalizer) [![Dependency Status](https://gemnasium.com/malmostad/siteseeker_normalizer.png)](https://gemnasium.com/malmostad/siteseeker_normalizer) [![Gem Version](https://badge.fury.io/rb/siteseeker_normalizer.png)](http://badge.fury.io/rb/siteseeker_normalizer)
 
-Ruby gem for Siteseeker integration. Performs requests and parses the response from Siteseeker. Search results is available as a structured object ready to use in Rails templates or another Ruby context.
+Ruby gem for Siteseeker integration. Performs requests and parses the response from Siteseeker. Search results is available as a structured object.
 
 ## Requirements
-* Ruby 1.9.3 or 2.0.
+* Ruby 1.9.3, 2.0.0 or 2.1.0.
 * A [Siteseeker](http://www.siteseeker.se/) account.
 
 ## Installation
@@ -22,13 +22,62 @@ Or install it yourself as:
 
     $ gem install siteseeker_normalizer
 
-If you get an error message about Nokogiri, install it with `sudo` first:
-
-    $ sudo gem install nokogiri
-
 ## Usage
-
-TODO: write spec
+Check out the the Rails app [Intranet Dashboard](https://github.com/malmostad/intranet-dashboard) in the `site_search` controller and views or the standalone Sinatra search app [Sitesearch](https://github.com/malmostad/sitesearch). Both are using memcached wrappers for the fetched search results.
+
+```Ruby
+require 'siteseeker_normalizer'
+
+# Initialize a search client with your account name and a search index name.
+client = SiteseekerNormalizer::Client.new("account_name", "index_name")
+
+# Search query with a search string.
+results = client.search("parkering")
+
+# Search query with a Hash of parameters
+# Used for category filtering, load more results etc. where the query comes from a previous result.
+results = client.search(params)
+
+# Fetch the results first and then parse. Useful for caching the response before parsing.
+raw_results = client.fetch("parkering")
+raw_results = client.fetch(params)
+results = SiteseekerNormalizer::Parse.new(raw_results)
+
+# Parsed response
+results.total                      # => 1008
+results.entries                    # => Array with result entries
+
+# First entry in results
+entry = results.entries.first
+entry.title                        # => "Boendeparkering"
+entry.summary                      # => "Boendeparkering finns snart i 19 ..."
+entry.date                         # => "2013-12-17"
+entry.breadcrumbs.first.text       # => "malmo.se"
+entry.breadcrumbs.first.url        # => "http://www.malmo.se/Medborgare.html"
+entry.category                     # => "Ämnessidor: Stadsplanering & trafik"
+
+# Sorting, Array with sorting alternatives
+results.sorting.first.text         # => "Relevans"
+results.sorting.first.query        # => "q=parkering&t=simple&ls=2&d=0&d1=01&d2 ..."
+results.sorting.first.current      # => false
+
+# Query for loading more results
+results.more_query                 # => "q=parkering&t=simple&ls=2&d=0&d1=01&d2 ..."
+
+# Array with categories for the results, used for filtering
+category_group = results.category_groups.first
+category_group.title               # => "Ämnessidor"
+category = category_group.categories.first
+category.current?                  # => false
+category.hits                      # => "12"
+category.title                     # => "Biblioteken"
+category.query                     # => "q=parkering&t=simple&ls=2&d=0&d1=01&d2 ..."
+
+# Spelling suggestions
+results = client.search("parkkering")
+results.suggestions.first.text     # => "parkering"
+results.suggestions.first.url      # => "q=parkering&t=simple&ls=2&d=0&d1=01& ..."
+```
 
 ## Testing
 Run:
@@ -46,3 +95,4 @@ Run:
 
 ## License
 Released under AGPL version 3.
+

data/lib/siteseeker_normalizer/client.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 require 'open-uri'
+require 'nokogiri'
 require 'uri'
 
 module SiteseekerNormalizer
@@ -18,7 +19,7 @@ module SiteseekerNormalizer
       if query.is_a? Hash
         query = URI.encode_www_form(query)
       else
-        query = "q=#{query}"
+        query = "q=#{URI.encode_www_form_component(query)}"
       end
       open("#{@base_search_url}&#{query}", read_timeout: @options[:read_timeout]).read
     end

data/lib/siteseeker_normalizer/version.rb

@@ -1,3 +1,3 @@
 module SiteseekerNormalizer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: siteseeker_normalizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - martent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Siteseeker integration library
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - COPYING
 - Gemfile
 - README.md
@@ -101,12 +101,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []