onestop-id-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2d5191c9603fa00e9600e4a20cb387edfcea70e
+  data.tar.gz: 4b2ef31690266190a6021b24fbae001473551e03
+SHA512:
+  metadata.gz: 08cc15f088c52c6ead6c0d63632e8e373281e32ea53fda91a321bc63648efaafd397c4b85adbc2c0d99a4b7e3b01c9bdac325e9ec3f8e15cb93def9fcadd0f6f
+  data.tar.gz: 06ad685c168879320fbc66cc3518863134332953bdbba76570a7b625566a749d25ea5a3412621d970c9359c4d27d81a7e19a57ab622ab34c5d0d7c1e47eeb700

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mapzen
+
+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,26 @@
+[![Circle CI](https://circleci.com/gh/transitland/onestop-id-ruby-client.svg?style=svg)](https://circleci.com/gh/transitland/onestop-id-ruby-client)
+
+# onestop-id-(ruby)-client
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'onestop-id-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onestop-id-client
+
+## Usage
+
+- `ENV['ONESTOP_ID_REGISTRY_REMOTE_URL']`
+- `ENV['ONESTOP_ID_REGISTRY_LOCAL_PATH']`

data/lib/onestop_id_client/entities/base_entity.rb

@@ -0,0 +1,42 @@
+require_relative '../registry'
+
+require 'json'
+
+module OnestopIdClient
+  module Entities
+    class BaseEntity
+      def initialize(directory, onestop_id: nil, json_blob: nil)
+        if onestop_id
+          begin
+            json_file = File.open(File.join(directory, "#{onestop_id}.json"), 'r')
+            parsed_json = JSON.parse(json_file.read)
+          rescue Errno::ENOENT
+            raise StandardError.new("no JSON file found with a Onestop ID of #{onestop_id}")
+          end
+        elsif json_blob
+          parsed_json = JSON.parse(json_blob)
+        else
+          raise ArgumentError.new('provide a Onestop ID or a JSON blob')
+        end
+
+        map_from_json_properties_to_object_variables(parsed_json)
+
+        @parsed_json = parsed_json
+
+        self
+      end
+
+      def self.all(directory, force_reload: false)
+        if force_reload || !defined?(@entity_objects)
+          @entity_objects = []
+          files = Dir.glob(File.join(directory, '*.json'))
+          files.each do |file_path|
+            json_file = File.open(file_path, 'r')
+            @entity_objects << new(json_blob: json_file.read)
+          end
+        end
+        @entity_objects
+      end
+    end
+  end
+end

data/lib/onestop_id_client/entities/feed.rb

@@ -0,0 +1,50 @@
+require_relative 'base_entity'
+require_relative 'operator_in_feed'
+
+module OnestopIdClient
+  module Entities
+    class Feed < BaseEntity
+      DIRECTORY = File.join(OnestopIdClient::Registry::LOCAL_PATH, 'feeds')
+
+      attr_accessor :onestop_id, :url, :feed_format, :tags, :operators_in_feed
+
+      def initialize(onestop_id: nil, json_blob: nil)
+        super(DIRECTORY, onestop_id: onestop_id, json_blob: json_blob)
+        @operators_in_feed = create_operators_in_feed(@parsed_json['operatorsInFeed'])
+        self
+      end
+
+      def self.find_by(gtfs_data_exchange_id: nil)
+        if gtfs_data_exchange_id
+          all.find { |feed| feed.tags['gtfs_data_exchange_id'] == gtfs_data_exchange_id }
+        else
+          raise ArgumentError.new('must specify a GTFS Data Exchange ID')
+        end
+      end
+
+      def self.all(force_reload: false)
+        super(DIRECTORY, force_reload: force_reload)
+      end
+
+      private
+
+      def create_operators_in_feed(parsed_json_array)
+        array = parsed_json_array.map do |parsed_json_object|
+          OperatorInFeed.new(feed: self, operator_onestop_id: parsed_json_object['onestopId'], gtfs_agency_id: parsed_json_object['gtfsAgencyId'])
+        end
+        array
+      end
+
+      def map_from_json_properties_to_object_variables(parsed_json)
+        [
+          ['@onestop_id', 'onestopId'],
+          ['@url', 'url'],
+          ['@feed_format', 'feedFormat'],
+          ['@tags', 'tags'],
+        ].each do |mapping|
+          instance_variable_set(mapping[0], parsed_json[mapping[1]])
+        end
+      end
+    end
+  end
+end

data/lib/onestop_id_client/entities/operator.rb

@@ -0,0 +1,42 @@
+require_relative 'base_entity'
+
+module OnestopIdClient
+  module Entities
+    class Operator < BaseEntity
+      DIRECTORY = File.join(OnestopIdClient::Registry::LOCAL_PATH, 'operators')
+
+      attr_accessor :onestop_id, :name, :tags, :identifiers, :geometry
+
+      def initialize(onestop_id: nil, json_blob: nil)
+        super(DIRECTORY, onestop_id: onestop_id, json_blob: json_blob)
+        self
+      end
+
+      def self.find_by(us_ntd_id: nil)
+        if us_ntd_id
+          all.find { |operator| operator.tags['us_national_transit_database_id'] == us_ntd_id }
+        else
+          raise ArgumentError.new('must specify a US NTD ID')
+        end
+      end
+
+      def self.all(force_reload: false)
+        super(DIRECTORY, force_reload: force_reload)
+      end
+
+      private
+
+      def map_from_json_properties_to_object_variables(parsed_json)
+        [
+          ['@onestop_id', 'onestopId'],
+          ['@name', 'name'],
+          ['@tags', 'tags'],
+          ['@identifiers', 'identifiers'],
+          ['@geometry', 'geometry']
+        ].each do |mapping|
+          instance_variable_set(mapping[0], parsed_json[mapping[1]])
+        end
+      end
+    end
+  end
+end

data/lib/onestop_id_client/entities/operator_in_feed.rb

@@ -0,0 +1,37 @@
+require_relative 'base_entity'
+require_relative 'feed'
+require_relative 'operator'
+
+module OnestopIdClient
+  module Entities
+    class OperatorInFeed
+      attr_accessor :gtfs_agency_id, :operator_onestop_id, :feed_onestop_id, :operator, :feed
+
+      def initialize(gtfs_agency_id: nil, operator_onestop_id: nil, feed_onestop_id: nil, operator: nil, feed: nil)
+        if operator
+          @operator = operator
+        elsif operator_onestop_id
+          @operator = Operator.new(onestop_id: operator_onestop_id)
+        else
+          raise ArgumentError.new('an operator object or Onestop ID must be specified')
+        end
+
+        if feed
+          @feed = feed
+        elsif feed_onestop_id
+          @feed = Feed.new(onestop_id: feed_onestop_id)
+        else
+          raise ArgumentError.new('a feed object or Onestop ID must be specified')
+        end
+
+        if gtfs_agency_id
+          @gtfs_agency_id = gtfs_agency_id
+        elsif feed
+          # TODO: handle this?
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/onestop_id_client/entities/route.rb

@@ -0,0 +1,8 @@
+require_relative 'base_entity'
+
+module OnestopIdClient
+  module Entities
+    class Route < BaseEntity
+    end
+  end
+end

data/lib/onestop_id_client/entities/stop.rb

@@ -0,0 +1,8 @@
+require_relative 'base_entity'
+
+module OnestopIdClient
+  module Entities
+    class Stop < BaseEntity
+    end
+  end
+end

data/lib/onestop_id_client/onestop_id.rb

@@ -0,0 +1,99 @@
+module OnestopIdClient
+  class OnestopId
+    ENTITY_TO_PREFIX = {
+      'stop' => 's',
+      'operator' => 'o',
+      'feed' => 'f',
+      'route' => 'r'
+    }
+    PREFIX_TO_ENTITY = ENTITY_TO_PREFIX.invert
+    COMPONENT_SEPARATOR = '-'
+
+    attr_accessor :entity_prefix, :geohash, :name
+
+    def initialize(string: nil, entity_prefix: nil, geohash: nil, name: nil)
+      errors = []
+
+      if string && string.length > 0
+        is_a_valid_onestop_id, errors = OnestopId.validate_onestop_id_string(string)
+        if is_a_valid_onestop_id
+          @entity_prefix = string.split(COMPONENT_SEPARATOR)[0]
+          @geohash = string.split(COMPONENT_SEPARATOR)[1]
+          @name = string.split(COMPONENT_SEPARATOR)[2]
+          self
+        else
+          raise ArgumentError.new(errors.join(', '))
+        end
+      elsif entity_prefix && geohash && name
+        if OnestopId.valid_component?(:entity_prefix, entity_prefix)
+          @entity_prefix = entity_prefix
+        else
+          errors << 'invalid entity prefix'
+        end
+        if OnestopId.valid_component?(:geohash, geohash)
+          @geohash = geohash
+        else
+          errors << 'invalid geohash'
+        end
+        if OnestopId.valid_component?(:name, name)
+          @name = name
+        else
+          errors << 'invalid name'
+        end
+      else
+        errors << 'either a string or entity/geohash/name must be specified'
+      end
+
+      if errors.length > 0
+        raise ArgumentError.new(errors.join(', '))
+      else
+        self
+      end
+    end
+
+    def self.validate_onestop_id_string(onestop_id, expected_entity_type: nil)
+      errors = []
+      is_a_valid_onestop_id = true
+      
+      if onestop_id.split(COMPONENT_SEPARATOR).length != 3
+        errors << 'must include 3 components separated by hyphens ("-")'
+        is_a_valid_onestop_id = false
+      end
+
+      if expected_entity_type && onestop_id.split(COMPONENT_SEPARATOR)[0] != ENTITY_TO_PREFIX[expected_entity_type]
+        errors << "must start with \"#{ENTITY_TO_PREFIX[expected_entity_type]}\" as its 1st component"
+        is_a_valid_onestop_id = false
+      elsif expected_entity_type == nil && !valid_component?(:entity_prefix, onestop_id.split(COMPONENT_SEPARATOR)[0])
+        errors << "must start with \"#{ENTITY_TO_PREFIX.values.join(' or ')}\" as its 1st component"
+        is_a_valid_onestop_id = false
+      end
+
+      if onestop_id.split(COMPONENT_SEPARATOR)[1].length == 0 || !valid_component?(:geohash, onestop_id.split(COMPONENT_SEPARATOR)[1])
+        errors << 'must include a valid geohash as its 2nd component'
+        is_a_valid_onestop_id = false
+      end
+      
+      if !valid_component?(:name, onestop_id.split(COMPONENT_SEPARATOR)[2])
+        errors << 'must include only letters and digits in its abbreviated name (the 3rd component)'
+        is_a_valid_onestop_id = false
+      end
+      return is_a_valid_onestop_id, errors
+    end
+
+    private
+
+    def self.valid_component?(component, value)
+      return false if !value || value.length == 0
+      case component
+      when :entity_prefix
+        ENTITY_TO_PREFIX.values.include?(value)
+      when :geohash
+        !(value =~ /[^a-z\d]/)
+      when :name
+        !(value =~ /[^a-zA-Z\d]/)
+      else
+        false
+      end
+    end
+  end
+end

data/lib/onestop_id_client/registry.rb

@@ -0,0 +1,32 @@
+require 'git'
+
+module OnestopIdClient
+  class Registry
+    include Singleton
+
+    REMOTE_URL = ENV['ONESTOP_ID_REGISTRY_REMOTE_URL'] || 'git@github.com:transitland/onestop-id-registry.git'
+    LOCAL_PATH = ENV['ONESTOP_ID_REGISTRY_LOCAL_PATH'] || File.join(__dir__, '..', '..','tmp', 'onestop-id-registry')
+
+    def self.repo(force_update: false)
+      if !defined?(@repo) || force_update
+        begin
+          @repo = Git.open(LOCAL_PATH)
+          @repo.pull if force_update
+        rescue ArgumentError => error
+          if error.message == 'path does not exist'
+            @repo = Git.clone(REMOTE_URL, LOCAL_PATH)
+          end
+        end
+      end
+
+      # TODO: remove when this is complete: https://github.com/transitland/onestop-id-registry/pull/12
+      @repo.branch("remotes/origin/extract-ruby").checkout
+
+      @repo
+    end
+
+    def self.json_files_for_entity(entity)
+      Dir[File.join(LOCAL_PATH, entity, '**', '*.json')]
+    end
+  end
+end

data/lib/onestop_id_client/version.rb

@@ -0,0 +1,3 @@
+module OnestopIdClient
+  VERSION = '0.0.1'
+end

data/lib/onestop_id_client.rb

@@ -0,0 +1,4 @@
+Gem.find_files("onestop_id_client/**/*.rb").each { |path| require path }
+
+module OnestopIdClient
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: onestop-id-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Drew Dara-Abrams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- drew@mapzen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/onestop_id_client.rb
+- lib/onestop_id_client/entities/base_entity.rb
+- lib/onestop_id_client/entities/feed.rb
+- lib/onestop_id_client/entities/operator.rb
+- lib/onestop_id_client/entities/operator_in_feed.rb
+- lib/onestop_id_client/entities/route.rb
+- lib/onestop_id_client/entities/stop.rb
+- lib/onestop_id_client/onestop_id.rb
+- lib/onestop_id_client/registry.rb
+- lib/onestop_id_client/version.rb
+homepage: https://github.com/transitland/onestop-id-ruby-client
+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.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: Read and write public-transit identities to the Onestop ID Registry/
+test_files: []
+has_rdoc: