bouncie 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cea0b513a9e2f94b59d868f815c66274e51403f831efc623cc25f71f9c102ca
-  data.tar.gz: 77bf54a4d53eb5161ea5d61198019c7ef1bd842cee90e8763d9901e4b347309c
+  metadata.gz: a4a21bb80e2739155f9d5e90b254d45fe7083659f11802ad79d2981a7773bd9f
+  data.tar.gz: 92a9a86b053858e14c5c675feeb278b32381d9065c7d9d74328e79ff8db82dd2
 SHA512:
-  metadata.gz: d5cc04aca9e0b798c78b0f39918857da2ef939a0b7fe4c4d24d3e4ddfc49564e18361abf6315efcadc40d420860ffa367d6ec351cedc5aa394a2ddebb7c55fa1
-  data.tar.gz: e2bdb550638c6e37cd324b00d2a4c6d52109e7568271fab12580040eae4c7e4d8e028531bd1152b1d963049de653dc7bb76e5c2fac7e0261468171ef6765cf90
+  metadata.gz: b1cd8e4e7bf3b355d360ebc2749f13c44946dfe4ff13edf51c81a7520302bcc4fcd1670c51c16512347072235ca51755ef799690bd59d9b480af05607a97b4aa
+  data.tar.gz: 2674f9a466d5e8a2af6f983ef001fe351cf8697b190d44401463d7e0082820167b051fd5d1ba3bfa681168d47ab41c0842bec49b123e3677c3faa7e54ad52f37

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: RSpec tests
+      run: rspec spec
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Rubocop Linter Action
+      uses: andrewmcodes/rubocop-linter-action@v3.2.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bouncie.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bouncie (0.3.0)
+    bouncie (0.4.0)
       activesupport
       faraday
       oj
@@ -15,16 +15,28 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    coderay (1.1.2)
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     i18n (1.8.3)
       concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
     minitest (5.14.1)
     multipart-post (2.1.1)
     oj (3.10.6)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -38,9 +50,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
     zeitwerk (2.3.0)
 
 PLATFORMS
@@ -49,8 +75,11 @@ PLATFORMS
 DEPENDENCIES
   bouncie!
   bundler (~> 2.0)
+  pry
   rake (~> 13.0)
   rspec (~> 3.2)
+  rubocop (~> 0.85.1)
+  yard (~> 0.9.25)
 
 BUNDLED WITH
    2.0.2

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "bouncie"
+require 'bundler/setup'
+require 'bouncie'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "bouncie"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bouncie.gemspec

@@ -1,37 +1,42 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "bouncie/version"
+require 'bouncie/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bouncie"
+  spec.name          = 'bouncie'
   spec.version       = Bouncie::VERSION
-  spec.authors       = ["Corey Psoinos"]
-  spec.email         = ["corey@streetsmarts.io"]
+  spec.authors       = ['Corey Psoinos']
+  spec.email         = ['corey@streetsmarts.io']
 
-  spec.summary       = %q{An API wrapper for Bouncie}
+  spec.summary       = 'An API wrapper for Bouncie'
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/streetsmartslabs/bouncie"
+  spec.homepage      = 'https://github.com/streetsmartslabs/bouncie'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.85.1'
+  spec.add_development_dependency 'yard', '~> 0.9.25'
 
-  spec.add_dependency "faraday"
-  spec.add_dependency "oj"
-  spec.add_dependency "activesupport"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'oj'
 end

data/lib/bouncie.rb

@@ -1,10 +1,20 @@
+# frozen_string_literal: true
+
 require 'bouncie/version'
 require 'bouncie/client'
 require 'bouncie/entity'
 require 'bouncie/vehicle'
 require 'bouncie/trip'
+require 'bouncie/webhook'
+require 'bouncie/device_events/connect_event'
+require 'bouncie/device_events/disconnect_event'
+require 'bouncie/vehicle_health_events/battery_event'
+require 'bouncie/vehicle_health_events/mil_event'
+require 'bouncie/vehicle_trip_events/trip_data_event'
+require 'bouncie/vehicle_trip_events/trip_end_event'
+require 'bouncie/vehicle_trip_events/trip_metrics_event'
+require 'bouncie/vehicle_trip_events/trip_start_event'
 
 module Bouncie
   class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/bouncie/client.rb

@@ -1,37 +1,53 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'oj'
 
 module Bouncie
+  # Class that wraps a Faraday connection in order to interact with the Bouncie API
   class Client
-    API_ENDPOINT = 'https://api.bouncie.dev/v1'.freeze
+    API_ENDPOINT = 'https://api.bouncie.dev/v1'
 
     attr_reader :options
 
+    # @param [Hash] options the options to create a `Bouncie::Client` with.
+    # @option opts [String] :api_key your Bouncie app's API key. Retrieve this from https://www.bouncie.dev/apps. Required.
+    # @option opts [String] :authorization_code code from a user who grants access to their information via OAuth. Required.
+    # @option opts [Hash] :headers hash of any additional headers to add to HTTP requests
     def initialize(options)
       @options = options
     end
 
+    # @param imei [String] (Required) IMEI for the vehicle to retrieve trips for
+    # @param transaction_id [String] Unique Trip Identifier
+    # @param gps_format [String] (Required) One of: `polyline` or `geojson`
+    # @param starts_after [ISODate] Will match trips with a starting time after this parameter. The window between starts-after and ends-before must be no longer than a week. If not provided, the last week will be used by default
+    # @param ends_before [ISODate] Will match trips with an ending time before this parameter
+    # @return [Trip]
     def trips(imei:, transaction_id: nil, gps_format: 'polyline', starts_after: nil, ends_before: nil)
       request(
         http_method: :get,
-        endpoint:    'trips',
+        endpoint: 'trips',
         params: {
-          imei:           imei,
+          imei: imei,
           transaction_id: transaction_id,
-          gps_format:     gps_format,
-          starts_after:   starts_after,
-          ends_before:    ends_before
+          gps_format: gps_format,
+          starts_after: starts_after,
+          ends_before: ends_before
         }.compact
       ).map { |data| Bouncie::Trip.new(data) }
     end
 
+    # @param vin [String] (optional) Vehicles with vin matching given value
+    # @param imei [String] (optional) Vehicles with imei matching given value
+    # @return [Vehicle]
     def vehicles(imei: nil, vin: nil)
       request(
         http_method: :get,
         endpoint: 'vehicles',
         params: {
           imei: imei,
-          vin:  vin
+          vin: vin
         }.compact
       ).map { |data| Bouncie::Vehicle.new(data) }
     end
@@ -39,14 +55,14 @@ module Bouncie
     private
 
     def headers
-      @_headers ||= {
+      @headers ||= {
         'AuthorizationCode' => options[:authorization_code],
-        'ApiKey'            => options[:api_key],
+        'ApiKey' => options[:api_key]
       }.merge(options[:headers] || {})
     end
 
     def client
-      @_client ||= Faraday.new(API_ENDPOINT, headers: headers) do |client|
+      @client ||= Faraday.new(API_ENDPOINT, headers: headers) do |client|
         client.request :url_encoded
         client.adapter Faraday.default_adapter
       end

data/lib/bouncie/device_events/connect_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module DeviceEvents
+    class ConnectEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/device_events/disconnect_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module DeviceEvents
+    class DisconnectEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/entity.rb

@@ -1,18 +1,13 @@
+# frozen_string_literal: true
+
 require 'active_support/inflector'
 
 module Bouncie
+  # Abstract base class for objects returned from API requests. Parses dates, converts keys to underscore.
   class Entity
     def initialize(data)
-      @data = data.transform_keys { |k| k.underscore.to_sym }
-      @data.each do |key, val|
-        if val.is_a?(Hash)
-          @data[key] = Bouncie::Entity.new(val)
-        elsif val.is_a?(Array)
-          @data[key] = val.map { |v| Bouncie::Entity.new(v) }
-        elsif val.is_a?(String) && ['_updated', '_time'].any? { |v| key.to_s.end_with?(v) }
-          @data[key] = DateTime.parse(val)
-        end
-      end
+      @data = data.transform_keys { |k| k.to_s.underscore.to_sym }
+      massage_data
     end
 
     def method_missing(method_name, *args, &block)
@@ -23,8 +18,22 @@ module Bouncie
       end
     end
 
-    def respond_to_missing?(method_name, include_private = false)
+    def respond_to_missing?(method_name, _include_private = false)
       @data.key?(method_name)
     end
+
+    private
+
+    def massage_data
+      @data.each do |key, val|
+        if val.is_a?(Hash)
+          @data[key] = Bouncie::Entity.new(val)
+        elsif val.is_a?(Array)
+          @data[key] = val.map { |v| Bouncie::Entity.new(v) }
+        elsif val.is_a?(String) && %w[_updated _time timestamp].any? { |v| key.to_s.end_with?(v) }
+          @data[key] = DateTime.parse(val)
+        end
+      end
+    end
   end
 end

data/lib/bouncie/trip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bouncie
   class Trip < Entity
   end

data/lib/bouncie/vehicle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bouncie
   class Vehicle < Entity
   end

data/lib/bouncie/vehicle_health_events/battery_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module VehicleHealthEvents
+    class BatteryEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/vehicle_health_events/mil_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module VehicleHealthEvents
+    class MilEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/vehicle_trip_events/trip_data_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module VehicleTripEvents
+    class TripDataEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/vehicle_trip_events/trip_end_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module VehicleTripEvents
+    class TripEndEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/vehicle_trip_events/trip_metrics_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module VehicleTripEvents
+    class TripMetricsEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/vehicle_trip_events/trip_start_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bouncie
+  module VehicleTripEvents
+    class TripStartEvent < Bouncie::Entity
+    end
+  end
+end

data/lib/bouncie/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bouncie
-  VERSION = "0.3.0"
+  VERSION = '0.4.0'
 end

data/lib/bouncie/webhook.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'bouncie/device_events/connect_event'
+require 'bouncie/device_events/disconnect_event'
+require 'bouncie/vehicle_health_events/battery_event'
+require 'bouncie/vehicle_health_events/mil_event'
+require 'bouncie/vehicle_trip_events/trip_data_event'
+require 'bouncie/vehicle_trip_events/trip_end_event'
+require 'bouncie/vehicle_trip_events/trip_metrics_event'
+require 'bouncie/vehicle_trip_events/trip_start_event'
+
+module Bouncie
+  # Class used for parsing webhooks into specific events.
+  class Webhook
+    WEBHOOK_EVENTS_MAP = {
+      'connect' => Bouncie::DeviceEvents::ConnectEvent,
+      'disconnect' => Bouncie::DeviceEvents::DisconnectEvent,
+      'battery' => Bouncie::VehicleHealthEvents::BatteryEvent,
+      'mil' => Bouncie::VehicleHealthEvents::MilEvent,
+      'trip_data' => Bouncie::VehicleTripEvents::TripDataEvent,
+      'trip_end' => Bouncie::VehicleTripEvents::TripEndEvent,
+      'trip_metrics' => Bouncie::VehicleTripEvents::TripMetricsEvent,
+      'trip_start' => Bouncie::VehicleTripEvents::TripStartEvent
+    }.freeze
+
+    def self.parse(data)
+      event_name = data[:event_type] || data[:eventType] || data['eventType'] || data['event_type']
+      event_klass = Bouncie::Webhook::WEBHOOK_EVENTS_MAP[event_name.underscore]
+      event_klass.new(data)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bouncie
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Corey Psoinos
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,8 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -112,10 +156,19 @@ files:
 - bouncie.gemspec
 - lib/bouncie.rb
 - lib/bouncie/client.rb
+- lib/bouncie/device_events/connect_event.rb
+- lib/bouncie/device_events/disconnect_event.rb
 - lib/bouncie/entity.rb
 - lib/bouncie/trip.rb
 - lib/bouncie/vehicle.rb
+- lib/bouncie/vehicle_health_events/battery_event.rb
+- lib/bouncie/vehicle_health_events/mil_event.rb
+- lib/bouncie/vehicle_trip_events/trip_data_event.rb
+- lib/bouncie/vehicle_trip_events/trip_end_event.rb
+- lib/bouncie/vehicle_trip_events/trip_metrics_event.rb
+- lib/bouncie/vehicle_trip_events/trip_start_event.rb
 - lib/bouncie/version.rb
+- lib/bouncie/webhook.rb
 homepage: https://github.com/streetsmartslabs/bouncie
 licenses: []
 metadata: