gospotcheck 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9e0c98c5dfd48d69d85b79937bbf9f668d091e1
+  data.tar.gz: 295752754d92e7746427986ebead24ee1f7a788d
+SHA512:
+  metadata.gz: 06a1d1bad7b0394b1b5a44cbafe3a0b6b50fac29ecd21c99cfdd6d8ff0664660cf48a4bb3b9841ef7693017920839d61f607f5afc313ff2435f4e59246acc9ea
+  data.tar.gz: 79eb1f64ef60fe059e6ac86d56f9ba0ee3efda53e9b12e4e3abf4444f7940d5c80026ea6fd7772411e438294cf45741c8baae54448f4d305d80f32a97668d052

data/.env.example

@@ -0,0 +1 @@
+OAUTH_TOKEN=INSERT_YOUR_OAUTH_TOKEN_HERE

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gospotcheck.gemspec
+
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 McBainCO
+
+MIT License
+
+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,46 @@
+# Gospotcheck
+
+## Description
+
+A gem to interact with the GoSpotCheck API. For more information on the GoSpotCheck API please see their [documentation](http://docs.gsc.apiary.io/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+client = Twitter::REST::Client.new do |config|
+  config.consumer_key        = "YOUR_CONSUMER_KEY"
+  config.consumer_secret     = "YOUR_CONSUMER_SECRET"
+  config.access_token        = "YOUR_ACCESS_TOKEN"
+  config.access_token_secret = "YOUR_ACCESS_SECRET"
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gospotcheck
+
+## Usage
+
+### On a Rails project
+
+Create a file in your config/intializers directory called gospotcheck.rb which includes the following code:
+
+```
+GoSpotCheck.client.configure do |config|
+  config.oauth_token = ENV['YOUR_GOSPOTCHECK_OAUTH_TOKEN']
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gospotcheck/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+

data/gospotcheck.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gospotcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gospotcheck'
+  spec.version       = Gospotcheck::VERSION
+  spec.authors       = ['McBainCO', 'lindsay-r', 'bscharm', 'lukemccomb']
+  spec.email         = ["bscharm@gmail.com\n"]
+  spec.summary       = 'Go Spot Check API gem'
+  spec.description   = 'Ruby wrapper for the goSpotcheck API written by a couple of plucky gSchoolers'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'dotenv'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.8'
+  spec.add_runtime_dependency 'simple_oauth', '~>0.2'
+
+end

data/lib/gospotcheck/client.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'gospotcheck/configuration'
+require 'gospotcheck/places'
+
+module GoSpotCheck
+
+  class Client
+    # set the root host for the GoSpotCheck API
+    API_HOST = "https://review.gospotcheck.com"
+
+    attr_reader :configuration
+    attr_writer :connection
+
+    def initialize(options = nil)
+      @configuration = nil
+
+      unless options.nil?
+        @configuration = Configuration.new(options)
+        check_api_keys
+      end
+
+    end
+
+    def configure
+      @configuration = Configuration.new
+
+      # yield to the configuration block in the Rails initializer
+      yield(@configuration)
+
+      check_api_keys
+    end
+
+    def check_api_keys
+      # check for configuration, if it exists prevent further modification
+      if configuration.nil? || !configuration.valid?
+        @configuration = nil
+      else
+        @configuration.freeze
+      end
+    end
+
+    def connection
+      return @connection if instance_variable_defined?(:@connection)
+
+      @connection = Faraday.new(API_HOST) do |conn|
+
+        # uses the default Net::HTTP adapter
+        conn.adapter Faraday.default_adapter
+      end
+
+      # set the Authorization header using the provided oauth token
+      @connection.headers["Authorization"] = "Bearer #{@configuration.auth_keys[:oauth_token]}"
+      @connection.headers["Content-Type"] = "application/json"
+
+      # return an instance of a connection with desired settings
+      @connection
+    end
+
+    def search(endpoint, params)
+      @places = GoSpotCheck::Places.new(connection)
+      @places.search(endpoint, params)
+    end
+
+  end
+
+end

data/lib/gospotcheck/configuration.rb

@@ -0,0 +1,31 @@
+module GoSpotCheck
+
+  class Configuration
+
+    AUTH_KEYS = [:oauth_token]
+
+    attr_accessor *AUTH_KEYS
+
+    def initialize(config_hash = nil)
+      if config_hash.is_a?(Hash)
+        config_hash.each do |config_name, config_value|
+          self.send("#{config_name}=", config_value)
+        end
+      end
+    end
+
+    # Returns a hash of api keys and their values
+    def auth_keys
+      AUTH_KEYS.inject({}) do |keys_hash, key|
+        keys_hash[key] = send(key)
+        keys_hash
+      end
+    end
+
+    def valid?
+      AUTH_KEYS.none?{ |key| send(key).nil? || send(key).empty? }
+    end
+
+  end
+
+end

data/lib/gospotcheck/places.rb

@@ -0,0 +1,19 @@
+module GoSpotCheck
+
+  class Places
+
+    # define the path for GoSpotCheck API places queries
+    # potential to further modify for use of different endpoints
+    PATH = "/external/v1/"
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def search(endpoint, params)
+      options = {endpoint: endpoint}
+      @connection.get PATH + options.fetch(:endpoint).to_s, params
+    end
+
+  end
+end

data/lib/gospotcheck/version.rb

@@ -0,0 +1,3 @@
+module Gospotcheck
+  VERSION = "0.0.2"
+end

data/lib/gospotcheck.rb

@@ -0,0 +1,10 @@
+require 'gospotcheck/version'
+require 'gospotcheck/client'
+
+module GoSpotCheck
+
+    def self.client
+      @client ||= GoSpotCheck::Client.new
+    end
+
+end

data/spec/gospotcheck_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe GoSpotCheck do
+
+  before(:all) do
+    @client = GoSpotCheck::Client.new({oauth_token: 'test'})
+    @client.connection = connection
+  end
+
+  let(:status_code) {JSON.parse(@client.search(:places, {'name.eq' => ''}).body)['request']['status_code']}
+
+  it 'responds to search' do
+    expect(@client).to respond_to(:search)
+  end
+
+  it 'returns the correct response' do
+    expect(@client.search(:places, {'name.eq' => ''})).to be_an_instance_of(Faraday::Response)
+    expect(status_code).to eq(200)
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/gospotcheck'
+require_relative './support/faraday_mock_connection'
+require 'pry-byebug'
+require 'json'

data/spec/support/faraday_mock_connection.rb

@@ -0,0 +1,7 @@
+def connection(options = {})
+  defaults = {:endpoint => :places}
+  defaults.merge!(options)
+  Faraday.new('http://private-anon-46d290685-gsc.apiary-mock.com/external/v1/' + defaults[:endpoint].to_s) do |conn|
+    conn.adapter Faraday.default_adapter
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: gospotcheck
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- McBainCO
+- lindsay-r
+- bscharm
+- lukemccomb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: dotenv
+  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: faraday
+  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: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Ruby wrapper for the goSpotcheck API written by a couple of plucky gSchoolers
+email:
+- |
+  bscharm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gospotcheck.gemspec
+- lib/gospotcheck.rb
+- lib/gospotcheck/client.rb
+- lib/gospotcheck/configuration.rb
+- lib/gospotcheck/places.rb
+- lib/gospotcheck/version.rb
+- spec/gospotcheck_spec.rb
+- spec/spec_helper.rb
+- spec/support/faraday_mock_connection.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Go Spot Check API gem
+test_files:
+- spec/gospotcheck_spec.rb
+- spec/spec_helper.rb
+- spec/support/faraday_mock_connection.rb