blippex_api 1.0.0.pre.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTE0NzZhODg2NjRjYmEwNTNjNDcyODIwNDVmOWNmODE5YWQ4ZTBiOQ==
+  data.tar.gz: !binary |-
+    Mjk0ZmRlYTU0ODAxNGI1N2ZiOWI3ODNmN2E4MjEwMTA5NGIzNmRmZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTZkMDQyNmI3OTczOTBhNzE1NTY5ODA5YzhlNzU4ZDNkMGQyMWRlNThhODY1
+    M2YxNjE5NDc3NzJiMmY1OWRhZDI5NzU2M2E5ZDJlNWFmZTBmYWQ5OWEzNWMz
+    YzA5MWQ1MDY3MTFjNTg2NmY2NGIzNjBjZWRjYjFmNTdiZDZhZWM=
+  data.tar.gz: !binary |-
+    NzFkZGM2OWM2MjI2YTM0MzczYjc4NmU5YzZjNTdhZTA2NGZjMjU3ZjBhOGQy
+    MjFjODdkNTk0NmEyNGZhMjI5ODAzNTA5ZjQ5NmI1YjcyOTk2OTc0ODA0YTZm
+    ODE0ZWI1NDUwZGM1NTRhN2UzZDc1MTNhZWM5NzczMmVhNDA3Y2Q=

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+Gemfile.lock
+report.html
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+- 2.0.0
+- 1.9.3
+- 1.9.2
+
+script: bundle exec rspec
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Y87RrmR7ZbZoZU9IfqCX9zuyQ3+47Xik68jQW9rr1LLuFFZhMhwz7+cBSm6g/3fnN8HMBPCavXnuqOZ6qlt7vtqLEik12e/cUPW5mzgLGafEkv6QYhWrIjl+tyIPyQvlAVm0+UyonBkkLKEa9pCdCVIgwQzqCW4wqG/HjiPOxzA=
+  gem: blippex_api
+  on:
+    repo: jonathanchrisp/blippex_api

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'coveralls', '~> 0.6.7', require: false
+gem 'simplecov'
+gem 'pry'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jonathan Chrisp
+
+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,146 @@
+# blippex_api
+A ruby wrapper for the blippex search engine made bythe people, forthe people.
+
+You can find out more about the Blippex API [here](https://archify.atlassian.net/wiki/display/blippexAPI/api.blippex.org).
+
+## Documentation
+* Original documenation: <https://archify.atlassian.net/wiki/display/blippexAPI/api.blippex.org>
+* Gem documentation: <http://rubydoc.info/gems/blippex_api>
+
+## Getting Started
+In order to be able to send API requests you'll first need to install the `blippex_api` gem.
+
+```ruby
+gem install blippex_api
+```
+
+Once you have completed the steps above, you can now create an instance of a `BlippexAPI::Client`:
+
+```ruby
+require 'blippex_api'
+api = BlippexAPI::Client.new
+```
+
+If you now look at your `BlippexAPI` object instance it will be similar to the following:
+
+```ruby
+<BlippexAPI::Client:0x007fe9a23055f0
+@adapter=:net_http,
+@api_endpoint="https://api.blippex.org/",
+@user_agent="BlippexAPI Ruby Gem 1.0.0">
+```
+
+## Example requests
+Now that you have an `BlippexAPI::Client` instance you can now make requests.
+
+### info endpoint
+
+```ruby
+api.info
+```
+
+The response is returned within a `Hashie::Mash` instance.
+
+```ruby
+{
+  "total_page_count"=>5654101,
+  "total_pageview_count"=>8662559,
+  "yesterday_page_count"=>55708,
+  "yesterday_pageview_count"=>67842,
+  "search_count_history"=> [
+    {
+      "date"=>"2013-09-24T00:00:00+00:00",
+      "value"=>"83115"
+    },
+    {
+      "date"=>"2013-09-23T00:00:00+00:00",
+      "value"=>"70182"
+    }
+  ]
+}
+```
+
+### search endpoint
+
+```ruby
+api.search :q => 'Lakers', :w => 20, :d => 2, :highlight => 1, :limit => 1, :offset => 1
+```
+
+As above, the response is returned within a `Hashie::Mash` instance.
+
+```ruby
+{
+  "request"=> {
+    "days"=>2,
+    "weight"=>20,
+    "limit"=>1,
+    "offset"=>1,
+    "query"=>"Lakers"
+    },
+    "total"=>31,
+    "hits_displayed"=>1,
+    "results"=> [
+      {
+        "_id"=>"1d431326999324b8eccb85b7399553f4",
+        "_source"=>"Blippex",
+        "url"=>"http://about.me/claresayas",
+        "last_seen_at"=>"2013-09-24T15:17:25-07:00",
+        "language"=>"en",
+        "title"=>"Clare Sayas (claresayas) on about.me",
+        "highlight"=>
+          " of the community managers for EdelmanSV.\nOn a mission to help entrepreuners find their voice and advance the field of public engagement.\n<mark>Lakers</mark> fan, film/tv enthusiast, relentless home",
+        "score"=> {
+          "score_raw_elasticsearch"=>0,
+          "score_raw_dwell"=>4.3298473876598,
+          "sum_time_spend"=>38,
+          "sum_visits"=>3,
+          "score_clean_elasticsearch"=>0,
+          "score_clean_dwell"=>0.86449725527946,
+          "score_final"=>0.69159780422356
+        }
+      }
+    ],
+    "total_pages_in_db"=>5687567
+}
+
+```
+
+### ratelimitstatus endpoint
+
+```ruby
+api.rate_limit_status
+```
+
+As above, the response is returned within a `Hashie::Mash` instance.
+
+```ruby
+{
+  "ip"=>"00.0.000.00",
+  "data"=> {
+    "info"=> {
+      "remaining"=>997,
+      "reset"=>1380136296,
+      "limit"=>1000
+    },
+    "search"=> {
+      "remaining"=>3587,
+      "reset"=>1380136296,
+      "limit"=>3600
+    }
+  }
+}
+```
+
+To find out more information about `Hashie` please visit the following link: <https://github.com/intridea/hashie>.
+
+## Tests
+There are a number of unit tests which are included as part of this project, please run:
+
+```ruby
+rspec spec
+```
+
+Please note that a number of tests still need to be added so I don't currently have complete coverage, subject to workload these will be slowly added over the next few months.
+
+## Feedback
+I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com.

data/bin/blippex_api

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'blippex_api'

data/blippex_api.gemspec

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + "/lib/blippex_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'blippex_api'
+  s.version     = BlippexAPI::VERSION
+  s.version     = BlippexAPI::VERSION + ".pre.#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
+  s.date        = '2013-09-25'
+  s.summary     = 'Blippex API ruby wrapper'
+  s.description = 'A ruby wrapper for the blippex search engine API made bythe people, forthe people'
+  s.author      = 'Jonathan Chrisp'
+  s.email       = 'jonathan@brandwatch.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/jonathanchrisp/blippex_api'
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+
+  s.add_runtime_dependency 'faraday', '~> 0.8.7'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
+  s.add_runtime_dependency 'hashie', '~> 2.0.5'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/blippex_api.rb

@@ -0,0 +1,29 @@
+require 'blippex_api/version'
+require 'blippex_api/configuration'
+require 'blippex_api/client'
+
+# BlippexAPI namespace module
+module BlippexAPI
+  extend Configuration
+  class << self
+
+    # Alias for BlippexAPI::Client.new
+    #
+    # @return [BlippexAPI::Client]
+    def new opts={}
+      BlippexAPI::Client.new opts
+    end
+
+    # Delegate to BlippexAPI::Client.new
+    def method_missing method, *args, &block
+      return super unless new.respond_to? method
+      new.send method, *args, &block
+    end
+
+    # Check if method responds_to?
+    def respond_to? method, include_private=false
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+end

data/lib/blippex_api/client.rb

@@ -0,0 +1,33 @@
+require 'blippex_api/connection'
+require 'blippex_api/request'
+
+require 'blippex_api/client/info'
+require 'blippex_api/client/search'
+require 'blippex_api/client/rate_limit_status'
+
+module BlippexAPI
+  # Client class to create BlippexAPI instances
+  class Client
+
+    attr_accessor *Configuration::OPTION_KEYS
+
+    def initialize opts={}
+      # Merge opts
+      opts = BlippexAPI.options.merge opts
+
+      # Create instance variables
+      Configuration::OPTION_KEYS.each do |k|
+        send "#{k}=", opts[k]
+      end
+    end
+
+    include BlippexAPI::Connection
+    include BlippexAPI::Request
+
+    # API endpoints
+    include BlippexAPI::Client::Info
+    include BlippexAPI::Client::Search
+    include BlippexAPI::Client::RateLimitStatus
+
+  end
+end

data/lib/blippex_api/client/info.rb

@@ -0,0 +1,14 @@
+module BlippexAPI
+  class Client
+    module Info
+
+      # Get search engine stats
+      #
+      # @return [Hashie::Mash] Hash containing the response
+      def info
+        get 'info'
+      end
+
+    end
+  end
+end

data/lib/blippex_api/client/rate_limit_status.rb

@@ -0,0 +1,15 @@
+module BlippexAPI
+  class Client
+    module RateLimitStatus
+
+      # Get request limit status
+      #
+      # @option opts [String] callback the response will use the JSONP format with a callback of the given name
+      # @return [Hashie::Mash] Hash containing the response
+      def rate_limit_status opts={}
+        get 'ratelimitstatus', opts
+      end
+
+    end
+  end
+end

data/lib/blippex_api/client/search.rb

@@ -0,0 +1,21 @@
+module BlippexAPI
+  class Client
+    module Search
+
+      # Get search data
+      #
+      # @param opts [String] q search term
+      # @option opts [Integer] w the scoring of the searchterms has on the ranking of the search result in percent
+      # @option opts [Integer] d the number of days the search should go back
+      # @option opts [Integer] highlight highlight=1 if you want to add an excerpt of the text with a the highlighted search terms
+      # @option opts [Integer] limit this is the number of individual objects that are returned (maximum 100)
+      # @option opts [Integer] offset this offsets the start of the results by the number specified
+      # @option opts [String] callback the response will use the JSONP format with a callback of the given name
+      # @return [Hashie::Mash] Hash containing the response
+      def search opts={}
+        get 'search', opts
+      end
+
+    end
+  end
+end

data/lib/blippex_api/configuration.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+
+module BlippexAPI
+  # Configuration module to set default and custom client credentials
+  module Configuration
+
+    OPTION_KEYS = [
+      'adapter',
+      'api_endpoint',
+      'user_agent'
+    ].freeze
+
+    DEFAULT_ADAPTER       = Faraday.default_adapter
+    DEFAULT_API_ENDPOINT  = 'https://api.blippex.org/'
+    DEFAULT_USER_AGENT    = "BlippexAPI Ruby Gem #{BlippexAPI::VERSION}".freeze
+
+    attr_accessor *OPTION_KEYS
+
+    # Extend hook
+    def self.extended(base)
+      base.reset
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Convert option_keys to hash and return
+    def options
+      OPTION_KEYS.inject({}){|o,k|o.merge!(k => send(k))}
+    end
+
+    # Reset the configuration options
+    def reset
+      self.adapter      = DEFAULT_ADAPTER
+      self.user_agent   = DEFAULT_USER_AGENT
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+    end
+  end
+end

data/lib/blippex_api/connection.rb

@@ -0,0 +1,31 @@
+require 'faraday_middleware'
+require 'faraday/utils/utils'
+
+module BlippexAPI
+  # Connection module to handle requests
+  module Connection
+    private
+
+    # Create a connection to send request
+    def connection opts={}
+      connection = Faraday.new(opts) do |conn|
+
+        if opts[:force_urlencoded]
+          conn.request :url_encoded
+        else
+          conn.request :json
+        end
+
+        conn.request :json
+        conn.use FaradayMiddleware::FollowRedirects
+        conn.use FaradayMiddleware::Mashify
+        conn.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+        conn.adapter adapter
+      end
+
+      connection.headers[:user_agent] = user_agent
+      connection
+    end
+
+  end
+end

data/lib/blippex_api/request.rb

@@ -0,0 +1,50 @@
+require 'multi_json'
+
+module BlippexAPI
+  # Request module to handle all requests to API
+  module Request
+
+    # Perform a get request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def get path, opts={}
+      request(:get, path, opts).body
+    end
+
+    private
+
+    # Sets connection options
+    #
+    # @param opts [Hash] hash of opts passed
+    # @return [Hash] connection options
+    def connection_options opts
+      {
+        :headers => {
+          :user_agent => user_agent
+        },
+        :force_urlencoded => opts.delete(:force_urlencoded) || false,
+        :url => api_endpoint
+      }
+    end
+
+    # Perform a request
+    #
+    # @param method [String] Type of request path
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response
+    def request method, path, opts={}
+      conn_options = connection_options opts
+      response = connection(conn_options).send(method) do |request|
+        case method
+        when :get
+          request.url path, opts
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/blippex_api/version.rb

@@ -0,0 +1,3 @@
+module BlippexAPI
+  VERSION = "1.0.0"
+end

data/lib/faraday/response/blippex_error.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'multi_json'
+
+module Faraday
+  # Response::BlippexAPI class to raise custom faraday middleware errors
+  class Response::BlippexAPI < Response::Middleware
+    ERROR_MAP = {
+      400 => BlippexAPI::BadRequest,
+      401 => BlippexAPI::Unauthorized,
+      403 => BlippexAPI::Forbidden,
+      404 => BlippexAPI::NotFound,
+      406 => BlippexAPI::NotAcceptable,
+      422 => BlippexAPI::UnprocessableEntity,
+      429 => BlippexAPI::TooManyRequests,
+      500 => BlippexAPI::InternalServerError,
+      501 => BlippexAPI::NotImplemented,
+      502 => BlippexAPI::BadGateway,
+      503 => BlippexAPI::ServiceUnavailable
+    }
+
+    def on_complete(response)
+      key = response[:status].to_i
+      raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+    end
+  end
+end

data/lib/faraday/utils/utils.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+
+# TODO: Remove this patch once latest faraday rc has been released
+# https://github.com/lostisland/faraday/issues/182#issuecomment-19518167
+module Faraday
+  # Overriding Faraday::Utils module build_nested_query method
+  module Utils
+    def build_nested_query(value, prefix = nil)
+      case value
+      when Array
+        value.map { |v| build_nested_query(v, "#{prefix}") }.join("&")
+        #value.map { |v| build_nested_query(v, "#{prefix}%5B%5D") }.join("&")
+      when Hash
+        value.map { |k, v|
+          build_nested_query(v, prefix ? "#{prefix}#{escape(k)}" : escape(k))
+          #build_nested_query(v, prefix ? "#{prefix}%5B#{escape(k)}%5D" : escape(k))
+        }.join("&")
+      when NilClass
+        prefix
+      else
+        raise ArgumentError, "value must be a Hash" if prefix.nil?
+        "#{prefix}=#{escape(value)}"
+      end
+    end
+  end
+end

data/spec/blippex_api_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe BlippexAPI do
+
+  describe 'when called' do
+    it 'should be an instance of Module' do
+      BlippexAPI.should be_an_instance_of Module
+    end
+  end
+
+  describe '.new' do
+    it 'is a BlippexAPI::Client' do
+      expect(BlippexAPI.new).to be_a BlippexAPI::Client
+    end
+  end
+
+  describe '.respond_to?' do
+    it 'returns true if new method exists' do
+      expect(BlippexAPI.respond_to?(:new, true)).to eq(true)
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,19 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter,
+]
+
+SimpleCov.start
+require 'blippex_api'
+
+RSpec.configure do |config|
+  config.color_enabled  = true
+  config.formatter      = :documentation
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: blippex_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.6
+platform: ruby
+authors:
+- Jonathan Chrisp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+description: A ruby wrapper for the blippex search engine API made bythe people, forthe
+  people
+email: jonathan@brandwatch.com
+executables:
+- blippex_api
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- bin/blippex_api
+- blippex_api.gemspec
+- lib/blippex_api.rb
+- lib/blippex_api/client.rb
+- lib/blippex_api/client/info.rb
+- lib/blippex_api/client/rate_limit_status.rb
+- lib/blippex_api/client/search.rb
+- lib/blippex_api/configuration.rb
+- lib/blippex_api/connection.rb
+- lib/blippex_api/request.rb
+- lib/blippex_api/version.rb
+- lib/faraday/response/blippex_error.rb
+- lib/faraday/utils/utils.rb
+- spec/blippex_api_spec.rb
+- spec/helper.rb
+homepage: https://github.com/jonathanchrisp/blippex_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Blippex API ruby wrapper
+test_files:
+- spec/blippex_api_spec.rb
+- spec/helper.rb