spot-gps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cefc691cf3adc7c13929ac4ad0aad2e03657b7e
+  data.tar.gz: 930728e3875f407014521e9f60bdbf3c9305076f
+SHA512:
+  metadata.gz: ee497615830b2294640d2752a7d8ca11100ba4f4b0e3fe1eb4d8002610343807fefb3841b3ac799253e28a250aeb5918aa8967149133eed8580714be79336172
+  data.tar.gz: 8f01ed30a2fa1e5c73cd911d36ec558266043396b9f0f21ab1021de1364f444af0b41665a53e0997564b480e16c96ba50a978b9d54240e11bb75c6d6b84314a1

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,74 @@
+# SPOT GPS
+
+A thin wrapper for SPOT's [API](http://www.findmespot.com/en/index.php?cid=1700).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spot-gps'
+```
+
+## Configuration
+
+There are 3 configuration options:
+
+```ruby
+SPOT.configure do |config|
+  config.logger = Logger.new(STDOUT)
+  config.open_timeout = 30
+  config.read_timeout = 80
+end
+```
+
+## Usage
+
+You can make API calls by using an instance of the `API` class:
+
+```ruby
+api = SPOT::API.new(feed_id: 'FEED_GIID', feed_password: 'OPTIONAL_PASSWORD')
+```
+
+### Resources
+
+Currently, the SPOT API only supports a single `messages` resource.
+
+#### Messages
+
+Messages are communications sent from a SPOT device.
+
+```ruby
+api.applicant.all     # => Returns a (paginated) list of all messages for a feed
+api.applicant.latest  # => Returns the most recent message for a feed
+```
+
+### Pagination
+
+All resources that support an `all` method also support pagination. By default,
+the first page of 50 records are fetched. To fetch subsequent pages (each of 50
+records), specify a `page`.
+
+```ruby
+api.message.all(page: 2)
+```
+
+### Filtering
+
+The SPOT API supports filtering by date.
+
+```ruby
+api.message.all(start_at: '2014-06-01T00:00:00', end_at: '2015-06-01T00:00:00')
+```
+
+### Error Handling
+
+TODO: Currently the gem will just raise RestClient errors.
+
+## Contributing
+
+1. Fork it ( https://github.com/greysteil/spot-gps/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/lib/spot-gps/api.rb

@@ -0,0 +1,13 @@
+module SPOT
+  class API
+    attr_reader :feed_id, :feed_password
+
+    def initialize(feed_id:, feed_password: nil)
+      @api_service = ApiService.new(feed_id: feed_id, feed_password: feed_password)
+    end
+
+    def messages
+      @messages ||= Services::Messages.new(@api_service)
+    end
+  end
+end

data/lib/spot-gps/api_service.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'base64'
+
+module SPOT
+  class ApiService
+    def initialize(feed_id:, feed_password: nil)
+      @feed_id = feed_id
+      @feed_password = feed_password
+    end
+
+    # Make a GET request to the SPOT API
+    def get(path:, params: {})
+      params = params.merge(feedPassword: feed_password) if feed_password
+
+      uri = URI.join(base_uri, path)
+      uri.query = URI.encode_www_form(params) if params.any?
+
+      request_options = {
+        url: uri.to_s,
+        method: :get,
+        headers: headers,
+        open_timeout: SPOT.open_timeout,
+        timeout: SPOT.read_timeout
+      }
+
+      response = RestClient::Request.execute(request_options)
+
+      JSON.parse(response.body.to_s)
+    end
+
+    private
+
+    attr_reader :feed_id, :feed_password
+
+    def base_uri
+      URI.join(SPOT.endpoint, feed_id + '/')
+    end
+
+    def headers
+      { 'Accept' => "application/json" }
+    end
+  end
+end

data/lib/spot-gps/configuration.rb

@@ -0,0 +1,35 @@
+module SPOT
+  module Configuration
+    attr_accessor :open_timeout, :read_timeout
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.open_timeout = 30
+      self.read_timeout = 80
+      RestClient.log = nil
+    end
+
+    def logger=(log)
+      if log.respond_to?(:<<)
+        RestClient.log = log
+      else
+        raise "#{log.class} doesn't seem to behave like a logger!"
+      end
+    end
+
+    def logger
+      RestClient.log ||= NullLogger.new
+    end
+
+    def endpoint
+      "https://api.findmespot.com/spot-main-web/consumer/rest-api/2.0/public/feed/"
+    end
+  end
+end

data/lib/spot-gps/null_logger.rb

@@ -0,0 +1,6 @@
+module SPOT
+  class NullLogger
+    def <<(*args)
+    end
+  end
+end

data/lib/spot-gps/services/base.rb

@@ -0,0 +1,13 @@
+module SPOT
+  module Services
+    class Base
+      extend Forwardable
+
+      def initialize(api_service)
+        @api_service = api_service
+      end
+
+      def_delegator :@api_service, :get
+    end
+  end
+end

data/lib/spot-gps/services/messages.rb

@@ -0,0 +1,37 @@
+module SPOT
+  module Services
+    class Messages < Base
+      def all(page: nil, start_at: nil, end_at: nil)
+        query_params = {}
+        query_params[:start] = start(page) if page
+        query_params[:startDate] = spot_formatted_time(start_at) if start_at
+        query_params[:endDate] = spot_formatted_time(end_at) if end_at
+
+        get(path: "message.json", params: query_params)
+      end
+
+      def latest
+        get(path: "latest.json")
+      end
+
+      private
+
+      def spot_formatted_time(time)
+        return nil unless time
+        time = Time.parse(time) if time.is_a?(String)
+        time = time.to_time if time.is_a?(Date) || time.is_a?(DateTime)
+
+        time.gmtime.strftime('%FT%T') + "-0000"
+      end
+
+      def start(page)
+        return nil unless page
+        raise ArgumentError, "page must be an integer" unless page.is_a?(Integer)
+        raise ArgumentError, "page must be non-negative" if page < 0
+
+        # SPOT start param is zero-indexed
+        (page - 1) * 50
+      end
+    end
+  end
+end

data/lib/spot-gps/version.rb

@@ -0,0 +1,3 @@
+module SPOT
+  VERSION = '0.0.1'.freeze
+end

data/lib/spot.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'rest-client'
+
+require 'spot-gps/version'
+require 'spot-gps/configuration'
+require 'spot-gps/null_logger'
+require 'spot-gps/api'
+require 'spot-gps/api_service'
+require 'spot-gps/services/base'
+require 'spot-gps/services/messages'
+
+module SPOT
+  extend Configuration
+end

data/spot-gps.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spot-gps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spot-gps'
+  spec.version       = SPOT::VERSION
+  spec.authors       = ['Grey Baker']
+  spec.email         = ['greysteil@gmail.com']
+  spec.summary       = %q{A wrapper for the SPOT API}
+  spec.description   = %q{A wrapper for the SPOT API}
+  spec.homepage      = 'http://github.com/greysteil/spot-gps'
+  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 'webmock', '~> 1.22'
+  spec.add_development_dependency 'rubocop', '~> 0.37.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+
+  spec.add_dependency 'rest-client', '~> 1.8.0'
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: spot-gps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Grey Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-10 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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: A wrapper for the SPOT API
+email:
+- greysteil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/spot-gps/api.rb
+- lib/spot-gps/api_service.rb
+- lib/spot-gps/configuration.rb
+- lib/spot-gps/null_logger.rb
+- lib/spot-gps/services/base.rb
+- lib/spot-gps/services/messages.rb
+- lib/spot-gps/version.rb
+- lib/spot.rb
+- spot-gps.gemspec
+homepage: http://github.com/greysteil/spot-gps
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A wrapper for the SPOT API
+test_files: []