transitland_client 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51540a969bfd94f06f1f072888a906b0d5d42051
+  data.tar.gz: a3c660825b13e17aad68b4a61600e2d7649ad4ec
+SHA512:
+  metadata.gz: e4e21ea7519d4469dca59cd01342daf406db62248834dbd576e3f83bd8e20d95824f342f1e2428e7b43feef7e0998807e576ebd27bf04e9a37b39f98a200fb57
+  data.tar.gz: 8ef9e2c092390fe1c60f32c14c0cbee798646d8d31543fa7816f1a52b7c83d4b4a8c9ceadc28d63444dfb6892029afaea1df2859da8f792411e20801029ccbcf

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,78 @@
+[![Circle CI](https://circleci.com/gh/transitland/transitland-ruby-client.svg?style=svg)](https://circleci.com/gh/transitland/transitland-ruby-client)
+[![Gem Version](https://badge.fury.io/rb/transitland-client.svg)](http://badge.fury.io/rb/transitland-client)
+
+# transitland-(ruby)-client
+
+This Ruby library enables you to read from the [Transitland Feed Registry](https://github.com/transitland/transitland-feed-registry). In the future, it will also provide access to the [Transitland Datastore](https://github.com/transitland/transitland-datastore), and allow you to write to both.
+
+## Installation
+
+These instructions assume you already have a Ruby 2.0+ interpreter available for local use.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transitland-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transitland-client
+
+## Configuration
+
+The following settings can be changed with environment variables:
+
+Environment variable name        | default value
+-------------------------------- | -------------
+`TRANSITLAND_FEED_REGISTRY_URL`  | `git@github.com:transitland/transitland-feed-registry.git`
+`TRANSITLAND_FEED_REGISTRY_PATH` | `./tmp/transitland-feed-registry`
+
+## Usage
+
+This library is intended for use within other software and services. It also includes its own console, which lets developers try functionality locally.
+
+To start the console:
+
+    bundle exec rake console
+
+To load a local copy of the [Transitland Feed Registry](https://github.com/transitland/transitland-feed-registry):
+
+    [1] pry(main)> TransitlandClient::FeedRegistry.repo
+
+To list all registries in the Feed Registry:
+
+    [2] pry(main)> TransitlandClient::Entities::Feed.all
+
+That returns a standard Ruby array, so you can also perform operators like counting the number of feeds in the registry:
+
+    [3] pry(main)> TransitlandClient::Entities::Feed.all.count
+    => 20
+
+To find a single feed by its [Onestop ID](https://github.com/transitland/onestop-id):
+
+    [4] pry(main)> TransitlandClient::Entities::Feed.find_by(onestop_id: 'f-9q9-actransit')
+
+To find all feeds that include an operator by its [Onestop ID](https://github.com/transitland/onestop-id):
+
+    [5] pry(main)> TransitlandClient::Entities::Feed.find_by(onestop_id: 'o-dhw-miamidadetransit')
+
+To find all feeds by a tag key and value:
+
+    [6] pry(main)> TransitlandClient::Entities::Feed.find_by(tag_key: 'license', tag_value: 'Creative Commons Attribution 3.0 Unported License')
+
+To find all feeds that include an operator identifier:
+
+    [7] pry(main)> TransitlandClient::Entities::Feed.find_by(operator_identifier: 'usntd://4034')
+
+To get the URL for a feed:
+
+    [8] pry(main)> TransitlandClient::Entities::Feed.find_by(onestop_id: 'f-9q9-bayarearapidtransit').url
+
+To update the local copy of the Feed Registry (pulling any recent commits):
+
+    [9] pry(main)> TransitlandClient::FeedRegistry.repo(force_update: true)

data/lib/transitland_client/entities/feed.rb

@@ -0,0 +1,85 @@
+require 'json'
+
+module TransitlandClient
+  module Entities
+    class Feed
+      attr_accessor :onestop_id, :url, :feed_format, :tags, :operators_in_feed
+
+      def initialize(onestop_id: nil, json_blob: nil)
+        if onestop_id
+          begin
+            json_file = File.open(FeedRegistry.json_file_for_entity_with_name('feeds', onestop_id), 'r')
+            parsed_json = JSON.parse(json_file.read)
+          rescue Errno::ENOENT
+            raise ArgumentError.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
+
+        @operators_in_feed = create_operators_in_feed(@parsed_json['operatorsInFeed'])
+
+        self
+      end
+
+      def self.find_by(onestop_id: nil, operator_identifier: nil, tag_key: nil, tag_value: nil)
+        if onestop_id && (onestop_id_object = OnestopId.new(string: onestop_id))
+          if onestop_id_object.entity_prefix == 'f'
+            self.new(onestop_id: onestop_id)
+          elsif onestop_id_object.entity_prefix == 'o'
+            all.find_all { |feed| feed.operators_in_feed.any? { |oif| oif.operator_onestop_id ==  onestop_id } }
+          end
+        elsif tag_key && tag_value
+          all.find_all { |feed| feed.tags[tag_key] == tag_value }
+        elsif operator_identifier
+          all.find_all { |feed| feed.operators_in_feed.any? { |oif| oif.identifiers.include?(operator_identifier) } }
+        else
+          raise ArgumentError.new('must specify a Onestop ID, a tag key and value, or an operator identifier.')
+        end
+      end
+
+      def self.all(force_reload: false)
+        if force_reload || !defined?(@entity_objects)
+          @entity_objects = []
+          files = FeedRegistry.json_files_for_entity('feeds')
+          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
+
+      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'],
+            identifiers: parsed_json_object['identifiers']
+          )
+        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/transitland_client/entities/operator_in_feed.rb

@@ -0,0 +1,26 @@
+require_relative 'feed'
+# require_relative 'operator'
+
+module TransitlandClient
+  module Entities
+    class OperatorInFeed
+      attr_accessor :gtfs_agency_id, :operator_onestop_id, :feed_onestop_id, :feed, :identifiers
+
+      def initialize(gtfs_agency_id: nil, operator_onestop_id: nil, feed_onestop_id: nil, feed: nil, identifiers: nil)
+        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
+
+        @gtfs_agency_id = gtfs_agency_id
+        @operator_onestop_id = operator_onestop_id
+        @identifiers = identifiers || []
+
+        self
+      end
+    end
+  end
+end

data/lib/transitland_client/feed_registry.rb

@@ -0,0 +1,37 @@
+require 'git'
+require 'singleton'
+require 'fileutils'
+
+module TransitlandClient
+  class FeedRegistry
+    include Singleton
+
+    def self.repo(force_update: false)
+      @remote_url ||= ENV['TRANSITLAND_FEED_REGISTRY_URL'] || 'git@github.com:transitland/transitland-feed-registry.git'
+      @local_path ||= ENV['TRANSITLAND_FEED_REGISTRY_PATH'] || File.join(__dir__, '..', '..','tmp', 'transitland-feed-registry')
+
+      if !defined?(@repo) || force_update
+        begin
+          FileUtils.mkdir_p(@local_path)
+
+          @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
+
+      @repo
+    end
+
+    def self.json_files_for_entity(entity)
+      Dir[File.join(@local_path, entity, '**', '*.json')]
+    end
+
+    def self.json_file_for_entity_with_name(entity, name)
+      File.join(@local_path, entity, "#{name}.json")
+    end
+  end
+end

data/lib/transitland_client/onestop_id.rb

@@ -0,0 +1,99 @@
+module TransitlandClient
+  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/transitland_client/version.rb

@@ -0,0 +1,3 @@
+module TransitlandClient
+  VERSION = '0.0.5'
+end

data/lib/transitland_client.rb

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

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: transitland_client
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Drew Dara-Abrams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 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/transitland_client.rb
+- lib/transitland_client/entities/feed.rb
+- lib/transitland_client/entities/operator_in_feed.rb
+- lib/transitland_client/feed_registry.rb
+- lib/transitland_client/onestop_id.rb
+- lib/transitland_client/version.rb
+homepage: https://github.com/transitland/transitland-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 data from the Transitland Datastore and Feed Registry
+test_files: []
+has_rdoc: