bike_reg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 373b63787be2322e1239615604ab77a8c9801d1863d5c139e042e9032bed9a23
+  data.tar.gz: caa5b4fbe34395309fc17b8e7e0c53b4f71361189593d25d6ac9b3a15b6790f3
+SHA512:
+  metadata.gz: 30a304b66889d358c7ca50dbdbebc56dfcb8eadce801c96b4e200dcba1dfb831226eddbe8501c6f7e8580375178ffdf4af1139e8f82e8e2d94cd3537e1c90d06
+  data.tar.gz: bd5a87f852845d9b46f2b0663852771edc75fa94b7f6ab7f270bbe1d2c024914cc7f8d9dbb0ffc5f21f4c086d78fb91facb40bdd2a407ed00dce0ec9691edbee

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-12
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bike_reg.gemspec
+gemspec
+
+gem 'pry'
+gem 'pry-nav'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.7'
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    bike_reg (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faraday (1.7.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.0.0)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bike_reg!
+  pry
+  pry-nav
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.2.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Scott Olsen
+
+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,51 @@
+# BikeReg API Rubygem
+
+[![Build Status](https://github.com/scottolsen/bike_reg/workflows/Specs/badge.svg)](https://github.com/scottolsen/bike_reg/actions)
+
+Simple gem to hit the [BikeReg
+API](https://www.bikereg.com/api/EventSearchDoc.aspx) to search for events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bike_reg'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bike_reg
+
+## Usage
+
+```ruby
+client = BikeReg::Client.new
+
+events = client.event.search
+#=> BikeReg::Collection
+
+events.total
+#=> 61
+
+events.data
+#=> [#<BikeReg::Event>, #<BikeReg::Event>]
+````
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scottolsen/bike_reg.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bike_reg'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bike_reg/client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BikeReg
+  class Client
+    BASE_URL = 'https://www.BikeReg.com/api'
+
+    def event
+      EventResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+      end
+    end
+  end
+end

data/lib/bike_reg/collection.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BikeReg
+  class Collection
+    attr_reader :data, :total, :next_page, :prev_page
+
+    def self.from_response(response, key:, type:, start_page:)
+      body = response.body
+      new(
+        data: body[key].map { |attrs| type.new(attrs) },
+        total: body['ResultCount'],
+        start_page: start_page
+      )
+    end
+
+    def initialize(data:, total:, start_page:)
+      @data = data
+      @total = total
+      @next_page = start_page.nil? ? 1 : start_page + 1
+      @prev_page = start_page.nil? ? 0 : start_page - 1
+    end
+  end
+end

data/lib/bike_reg/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BikeReg
+  class Error < StandardError
+  end
+end

data/lib/bike_reg/object.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module BikeReg
+  class Object < OpenStruct
+    def initialize(attributes)
+      super(to_ostruct(attributes))
+    end
+
+    def to_ostruct(obj)
+      case obj
+      when Hash
+        OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+      when Array
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/bike_reg/objects/event.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BikeReg
+  class Event < Object
+  end
+end

data/lib/bike_reg/resource.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BikeReg
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body['error']}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body['error']}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body['error']}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body['error']}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body['error']}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body['error']}"
+      when 503
+        raise Error,
+              "The server is currently unable to handle the request due to a temporary overloading or maintenance of the
+ server. #{response.body['error']}"
+      end
+
+      response
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/bike_reg/resources/event_resource.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module BikeReg
+  class EventResource < Resource
+    def search(**params)
+      response = get_request('search', params: params)
+      Collection.from_response(response, key: 'MatchingEvents', type: Event, start_page: params[:startpage])
+    end
+  end
+end

data/lib/bike_reg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BikeReg
+  VERSION = '0.1.0'
+end

data/lib/bike_reg.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'bike_reg/version'
+
+module BikeReg
+  autoload :Client, 'bike_reg/client'
+  autoload :Collection, 'bike_reg/collection'
+  autoload :Error, 'bike_reg/error'
+  autoload :Object, 'bike_reg/object'
+  autoload :Resource, 'bike_reg/resource'
+
+  autoload :EventResource, 'bike_reg/resources/event_resource'
+
+  autoload :Event, 'bike_reg/objects/event'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: bike_reg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Olsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Gem to hit the BikeReg.com API. BikeReg API docs here https://www.bikereg.com/api/EventSearchDoc.aspx
+email:
+- solsen300@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/bike_reg.rb
+- lib/bike_reg/client.rb
+- lib/bike_reg/collection.rb
+- lib/bike_reg/error.rb
+- lib/bike_reg/object.rb
+- lib/bike_reg/objects/event.rb
+- lib/bike_reg/resource.rb
+- lib/bike_reg/resources/event_resource.rb
+- lib/bike_reg/version.rb
+homepage: https://github.com/scottolsen/bike-reg
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Gem to hit the BikeReg.com API
+test_files: []