doublemap_api 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dde680b8393299472cc7dcb6a01ce62778cc5298
+  data.tar.gz: f1865c943dc16601c7d9b603ec9346b4cbd85aca
+SHA512:
+  metadata.gz: 47372e2dece943ae5ada69ff5820e019d582a797c2694269ebdfb281abb772cb0c8bb6d2691d6e6a079f50398b80acdc2b2b4bfbc688fb3a79d1acee380fec27
+  data.tar.gz: 37ad58f6f57c6e8314172109998bbaeeefd98582dfd5fcc810f86c2e94c770c1e99146ea00178c4a7a0da73b48a2a989a3fc6a5d6c5e9362831926b305514f93

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Jon Egeland
+
+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/lib/doublemap_api.rb

@@ -0,0 +1,32 @@
+require_relative 'doublemap_api/core_ext/string'
+
+require_relative 'doublemap_api/version'
+require_relative 'doublemap_api/configuration'
+require_relative 'doublemap_api/connection'
+require_relative 'doublemap_api/models'
+require_relative 'doublemap_api/api'
+require_relative 'doublemap_api/client'
+
+module DoubleMap
+  class << self
+    # Alias for `DoubleMap::Client.new`
+    def new
+      Client.new
+    end
+
+    # The current client configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Allow users to set configuration options via a block. By default, the
+    # configuration will be validated after the block returns. This will raise
+    # an exception if any required configurations are not provided. This
+    # behavior can be skipped by passing `validate: false` as a parameter.
+    def configure validate: true
+      yield configuration
+      configuration.validate! if validate
+      configuration
+    end
+  end
+end

data/lib/doublemap_api/api.rb

@@ -0,0 +1,52 @@
+require 'memoist'
+
+module DoubleMap
+  # A base class implementing common API operations
+  class API
+    include Connection
+
+    class << self
+      extend Memoist
+
+      # Include another API's functionality via a new method on this API.
+      # For example, `include_api :routes` would include the "Routes" API into
+      # the "Client" API, accessible as `Client#routes`.
+      def include_api name
+        klass = self.const_get(name.to_s.constantize)
+        define_method(name) do
+          klass.new
+        end
+        self.memoize name
+      end
+
+      # Require all the files given in `names` that exist in the given folder
+      def require_all folder, *libs
+        libs.each do |lib|
+          require_relative "#{File.join(folder, lib)}"
+        end
+      end
+
+      # Return a singleton instance of this API
+      def singleton
+        @singleton ||= self.new
+      end
+    end
+
+
+    # Perform a GET request over the connection to the given endpoint.
+    def get_request endpoint, opts={}, &block
+      connection.get endpoint, opts, &block
+    end
+
+    # Perform a POST request over the connection to the given endpoint.
+    def post_request endpoint, opts={}, &block
+      connection.post endpoint, opts, &block
+    end
+
+    # For APIs that extend Memoist, allow the user to call `refresh` as an
+    # alias for `flush_cache`.
+    def refresh
+      send(:flush_cache) if respond_to?(:flush_cache)
+    end
+  end
+end

data/lib/doublemap_api/client.rb

@@ -0,0 +1,17 @@
+require 'memoist'
+
+module DoubleMap
+  class Client < API
+    extend Memoist
+
+    require_all 'client',
+      'routes',
+      'stops',
+      'vehicles'
+
+    include_api :routes
+    include_api :stops
+    include_api :vehicles
+  end
+end
+

data/lib/doublemap_api/client/routes.rb

@@ -0,0 +1,19 @@
+module DoubleMap
+  class Client::Routes < API
+    extend Memoist
+
+    # Return a list of all routes on the system.
+    def list
+      get_request('/map/v2/routes').map{ |route| Route.new(route) }
+    end
+    memoize :list
+    alias_method :all, :list
+
+    # Return the route whose id matches the given id
+    def get id
+      list.find{ |route| route.id == id }
+    end
+    memoize :get
+    alias_method :find, :get
+  end
+end

data/lib/doublemap_api/client/stops.rb

@@ -0,0 +1,19 @@
+module DoubleMap
+  class Client::Stops < API
+    extend Memoist
+
+    # Return a list of all stops on the system.
+    def list
+      get_request('/map/v2/stops').map{ |stop| Stop.new(stop) }
+    end
+    memoize :list
+    alias_method :all, :list
+
+    # Return the route whose id matches the given id
+    def get id
+      list.find{ |stop| stop.id == id }
+    end
+    memoize :get
+    alias_method :find, :get
+  end
+end

data/lib/doublemap_api/client/vehicles.rb

@@ -0,0 +1,19 @@
+module DoubleMap
+  class Client::Vehicles < API
+    extend Memoist
+
+    # Return a list of all vehicles currently traveling on routes.
+    def list
+      get_request('/map/v2/buses').map{ |vehicle| Vehicle.new(vehicle) }
+    end
+    memoize :list
+    alias_method :all, :list
+
+    # Return the vehicle whose id matches the given id
+    def get id
+      list.find{ |vehicle| vehicle.id == id }
+    end
+    memoize :get
+    alias_method :find, :get
+  end
+end

data/lib/doublemap_api/configuration.rb

@@ -0,0 +1,41 @@
+module DoubleMap
+  class Configuration
+    # The version of the DoubleMap system
+    attr_accessor :version
+    # The base URL of the DoubleMap system
+    attr_accessor :base_uri
+    # The adapter to use for network communication
+    attr_accessor :adapter
+    # The output stream to which debug information should be written
+    attr_accessor :debug_output
+
+    # The defaults to use for any configuration options that are not provided
+    DEFAULT_CONFIGURATION = {
+      version: '3.2', # Taken from a comment on "http://bus.gocitybus.com/RouteMap/Index"
+      adapter: :httparty,
+      debug_output: false
+    }
+
+    # The options required when configuring a DoubleMap instance
+    REQUIRED_CONFIGURATION = [
+      :base_uri
+    ]
+
+    def initialize
+      # Apply the default set of configurations before anything else to ensure
+      # all options are initialized.
+      DEFAULT_CONFIGURATION.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    # Ensure that all required configurations have been given a value. Returns
+    # true if all required configuration options have been set.
+    def validate!
+      REQUIRED_CONFIGURATION.each do |name|
+        raise "`#{name}` is a required configuration option, but was not given a value." if send("#{name}").nil?
+      end
+      true
+    end
+  end
+end

data/lib/doublemap_api/connection.rb

@@ -0,0 +1,23 @@
+module DoubleMap
+  module Connection
+    extend self
+
+    # Return the connection adapter instance
+    def connection
+      @connection ||= adapter.new(DoubleMap.configuration)
+    end
+
+    # Return the class of the adapter to use for the connection
+    def adapter
+      @@adapters[DoubleMap.configuration.adapter]
+    end
+
+    # Register a new class that can be used as a connection adapter
+    def register_adapter name, klass
+      (@@adapters ||= {})[name] = klass
+    end
+  end
+end
+
+# Include the adapters that come packaged with the gem
+require_relative 'connection_adapters/httparty_adapter.rb'

data/lib/doublemap_api/connection_adapters/httparty_adapter.rb

@@ -0,0 +1,27 @@
+require 'httparty'
+require 'json'
+
+# A Connection adapter using HTTParty as the network transport
+module DoubleMap
+  module Connection
+    class HTTPartyAdapter
+      include HTTParty
+
+      def initialize config
+        self.class.base_uri config.base_uri
+        # Write debug information to the configured output stream
+        self.class.debug_output config.debug_output
+      end
+
+      def get endpoint, opts={}, &block
+        self.class.get(endpoint, opts, &block).parsed_response
+      end
+
+      def post endpoint, opts={}, &block
+        self.class.post(endpoint, opts, &block).parsed_response
+      end
+    end
+
+    register_adapter :httparty, HTTPartyAdapter
+  end
+end

data/lib/doublemap_api/core_ext/string.rb

@@ -0,0 +1,21 @@
+class String
+  def underscore
+    self.dup.underscore!
+  end unless method_defined? :underscore
+
+  def underscore!
+    self.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    self.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    self.tr_s!('- ', '_')
+    self.downcase!
+    self
+  end unless method_defined? :underscore!
+
+  def titleize
+    self.tr_s('- ', '_').split('_').map(&:capitalize).join(' ')
+  end unless method_defined? :titleize
+
+  def constantize
+    self.tr_s('- ', '_').split('_').map(&:capitalize).join
+  end unless method_defined? :constantize
+end

data/lib/doublemap_api/models.rb

@@ -0,0 +1,88 @@
+require 'set'
+
+module DoubleMap
+  class Model
+    extend Forwardable
+
+    class << self
+      # Define a new attribute of the model.
+      # If `type` is given, a new instance of `type` will be created whenever
+      # this attribute is assigned a value. This allows creation of nested
+      # objects from a simple Hash.
+      # If `type` is given and `array` is true, the value given to this
+      # attribute will be interpreted as an array and a new instance of `type`
+      # will be created for each entry in the array
+      # It `type` is given, and the value given to this attribute is nil, no
+      # new instance of `type` will be created. Instead, the value will remain
+      # nil, as an instance of NilClass.
+      def attribute name, type: nil, array: false
+        attributes << [name, type]
+        attr_reader name
+        # Use a custom writer method to allow typed attributes to be
+        # instantiated properly.
+        define_method "#{name}=" do |value|
+          # Only do type conversion if the type is specified and the value is
+          # not nil.
+          if type and !value.nil?
+            # Lookup is done on DoubleMap to ensure that Model subclasses are
+            # searched first, falling back to other types (Numeric, Hash, etc.)
+            # if no Model subclass is found.
+            klass = DoubleMap.const_get(type.to_s.constantize)
+            value = array ? value.map{ |v| klass.new(v) } : klass.new(value)
+          end
+          instance_variable_set("@#{name}", value)
+        end
+      end
+
+      # The list of attributes defined on the model
+      def attributes
+        @attributes ||= Set.new
+      end
+
+      # The attribute of the model that can be used to uniquely identify an
+      # instance from any other. The primary attribute should also be set
+      # with `attribute <name>`.
+      attr_accessor :identifier
+      def primary_attribute name
+        @identifier = name
+      end
+
+      # Define one or more delegated methods on the model, passing them to the
+      # given attribute.
+      def delegate *names, to:
+        names.each do |name|
+          def_delegator to, name
+        end
+      end
+    end
+
+    # Initialize a model instance with any given attributes assigned
+    def initialize args={}
+      assign(args)
+    end
+
+    # Mass assign a group of attributes. Attribute names will be automatically
+    # be converted to snake_case for consistency.
+    def assign args={}
+      args.each do |_name, value|
+        public_send("#{_name.underscore}=", value)
+      end
+    end
+
+    # The value of the primary attribute on this model
+    def identifier
+      send(self.class.identifier)
+    end
+
+    # Assume that two Model objects are the same if their primary attributes
+    # have the same value
+    def == o
+      identifier == o.identifier
+    end
+  end
+end
+
+# Include all model subclasses
+require_relative 'models/route'
+require_relative 'models/stop'
+require_relative 'models/vehicle'

data/lib/doublemap_api/models/route.rb

@@ -0,0 +1,36 @@
+module DoubleMap
+  class Route < Model
+    # The unique id used when referencing this route
+    attribute :id
+    # The full name of this route
+    attribute :name
+    # The name used to quickly identify this route
+    attribute :short_name
+    # A short summary of the purpose of this route
+    attribute :description
+    # The hexadecimal color to use when displaying this route
+    attribute :color
+    # The list of lat/lon points that this route passes through
+    attribute :path
+    # The time of day that this route becomes active
+    attribute :start_time
+    # The time of day that this route stops being active
+    attribute :end_time
+    # The url where schedule information for this route can be found
+    attribute :schedule_url
+    # Is the route currently an active route being serviced
+    attribute :active
+    alias_method :active?,    :active
+    alias_method :is_active,  :active
+    # NOTE: The purpose of this field is unknown, as it is almost always given
+    # a value of `null`.
+    # It's default value is a Hash, so the assumed purpose is extra information
+    # about the route that doesn't conform to the API schema.
+    attribute :fields
+    # The list of stop ids that this route passes through.
+    attribute :stops
+
+
+    primary_attribute :id
+  end
+end

data/lib/doublemap_api/models/stop.rb

@@ -0,0 +1,27 @@
+module DoubleMap
+  class Stop < Model
+    # The unique id used when referencing this stop
+    attribute :id
+    # The name of this stop
+    attribute :name
+    # A short summary of the purpose of this stop
+    attribute :description
+    # The latitudinal position of this stop
+    attribute :lat
+    alias_method :latitude, :lat
+    # The longitudinal position of this stop
+    attribute :lon
+    alias_method :longitude, :lon
+    # NOTE: The purpose of this field is unknown, as it is almost always given
+    # a value of `null`.
+    attribute :buddy
+    # NOTE: The purpose of this field is unknown, as it is almost always given
+    # a value of `null`.
+    # It's default value is a Hash, so the assumed purpose is extra information
+    # about the route that doesn't conform to the API schema.
+    attribute :fields
+
+
+    primary_attribute :id
+  end
+end

data/lib/doublemap_api/models/vehicle.rb

@@ -0,0 +1,32 @@
+module DoubleMap
+  class Vehicle < Model
+    # The unique id used when referencing this vehicle
+    attribute :id
+    # The name given to this vehicle
+    attribute :name
+    # The latitudinal position of this vehicle
+    attribute :lat
+    alias_method :latitude, :lat
+    # The longitudinal position of this vehicle
+    attribute :lon
+    alias_method :longitude, :lon
+    # NOTE: The purpose of this field is unknown, as it is almost always given
+    # a value of `null`.
+    attribute :heading
+    # The route this vehicle is currently traveling
+    attribute :route
+    # The last stop that this vehicle departed from
+    attribute :last_stop
+    # NOTE: The purpose of this field is unknown, as it is almost always given
+    # a value of `null`.
+    # It's default value is a Hash, so the assumed purpose is extra information
+    # about the route that doesn't conform to the API schema.
+    attribute :fields
+    # The time at which this vehicle was last updated. Stored as seconds since
+    # the Unix epoch.
+    attribute :last_update
+
+
+    primary_attribute :id
+  end
+end

data/lib/doublemap_api/version.rb

@@ -0,0 +1,3 @@
+module DoubleMap
+  VERSION = "2.0.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: doublemap_api
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Jon Egeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: A Ruby client for the DoubleMap real-time transit API. The major version
+  of this gem will match the version of the DoubleMap API that it is built for (e.g.,
+  2.0.0 -> v2).
+email: jonegeland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- LICENSE
+- lib/doublemap_api.rb
+- lib/doublemap_api/api.rb
+- lib/doublemap_api/client.rb
+- lib/doublemap_api/client/routes.rb
+- lib/doublemap_api/client/stops.rb
+- lib/doublemap_api/client/vehicles.rb
+- lib/doublemap_api/configuration.rb
+- lib/doublemap_api/connection.rb
+- lib/doublemap_api/connection_adapters/httparty_adapter.rb
+- lib/doublemap_api/core_ext/string.rb
+- lib/doublemap_api/models.rb
+- lib/doublemap_api/models/route.rb
+- lib/doublemap_api/models/stop.rb
+- lib/doublemap_api/models/vehicle.rb
+- lib/doublemap_api/version.rb
+homepage: http://github.com/propershark/doublemap_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: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the DoubleMap real-time transit API.
+test_files: []