location-service-client 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+0.1.0 6/24/2016
+==============
+
+Include active record validators so we can fake some aspects of ActiveRecord associations, like nested attributes and belongs_to...
+
+0.0.7 6/6/2016
+==============
+
+Add the SAS id.
+
+0.0.6 5/24/2016
+==============
+
+### Features
+
+Return struct location objects instead of hashes.
+
+Change ruby_timezone into a dynamic method on an instance instead of something we calculate for every locoation.
+
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gem 'rspec'
+gem 'activerecord'
+gem 'config'
+gem 'json'
+gem 'rest-client'
+gem 'activesupport'
+gem 'tzinfo'
+

data/README.md

@@ -0,0 +1,47 @@
+# location-service-client
+
+A gem for clients of Springshot's location service
+
+## Installation 
+
+Add it to your gemfile.
+
+```
+gem 'location-service-client', git: 'https://8bcbcee566e5e7a5d75592940d15bc9f68b84bd9:x-oauth-basic@github.com/springshot/location-service-client.git'
+```
+
+## Configuration
+
+Settings.location_service (c.f. the 'config' gem) will need a url for the location service
+and the app token configured to access the locations end point. 
+
+```
+location_service
+  url: ...
+  token: ...
+```
+
+## Documentation
+
+The location service client just adds a dead simple Location class that presently downloads a big array of nested hashes (with indifferent access and the keys snake-cased) of all locations in the location service and some helper methods.
+
+```
+> Location.all
+=> [{"id"=>449, "name"=>"Hartsfield-Jackson Atlanta International Airport", "code"=>"ATL", "kind"=>"airport", "lat"=>33.640067, "lng"=>-84.44403, "parent_location_id"=>nil, "created_at"=>"2016-04-28T21:19:02.658Z", "updated_at"=>"2016-04-28T21:19:02.658Z", "beacons"=>[], "child_locations"=>[..]},...]
+```
+
+There are some top level methods for accessing that data:
+
+```
+Location.find(id) -> find the location by its location service ID.
+Location.find_by_code(code) -> return the hash of the location with the code (e.g. an airport's IATA code or a gate's qr_code).
+Location.parents -> return just the roots of the trees
+```
+
+And until it needs to do more that's all it does.
+
+
+## Contributing
+
+Make sure any backwards incompatible changes come with a version bump so existing projects aren't obliterated.
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+

data/lib/location-service-client.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/location'
+module LocationServiceClient
+  autoload :Version, 'version'
+end

data/lib/location.rb

@@ -0,0 +1,100 @@
+require 'json'
+require 'rest-client'
+require 'active_support/cache'
+require 'tzinfo'
+require 'logger'
+require 'active_record'
+
+class Location < Struct.new(:id, :sas_id, :name, :code, :kind, :lat, :lng, :timezone, :parent_location_id, :updated_at, :created_at, :child_locations, :beacons)
+  include ActiveModel::Validations
+
+  def ruby_timezone
+    begin 
+      TZInfo::Timezone.get(timezone) if timezone && !timezone.empty?
+    rescue TZInfo::InvalidTimezoneIdentifier 
+      raise TZInfo::InvalidTimezoneIdentifier.new("'#{timezone}' is an invalid identifier")
+    end
+  end
+
+  class << self
+    # For mapping the JSON camelcase data from the location service into the Location structs:
+    KEY_ORDER = [:id, :sasId, :name, :code, :kind, :lat, :lng, :timezone, :parentLocationId, :updatedAt, :createdAt, :childLocations, :beacons].map(&:to_s).freeze
+    CACHE_KEY = 'location_service_request_cache'.freeze
+
+    def find(id)
+      flattened.detect{|l| l.id == id }
+    end
+
+    def find_by_code(code)
+      flattened.detect{|l| l.code == code }
+    end
+
+    def find_by_parent_code_and_child_name(parent_code, child_name)
+      airport = all.detect {|l| l.code == parent_code}
+      airport.try(:child_locations) && airport.child_locations.detect {|l| l.name == child_name }
+    end
+    alias_method :find_by_airport_and_gate, :find_by_parent_code_and_child_name
+
+    def find_by_codes(codes, child_locations=nil)
+      child_locations ||= all
+      codes             = [codes].flatten
+      code              = codes.shift
+      leaf              = child_locations.detect{|l| l.code == code }
+      codes.empty? ? leaf : find_by_codes(codes, leaf.child_locations) 
+    end
+
+    def children
+      all.map{|l| l.child_locations }.compact
+    end
+
+    def flattened
+      (all + children).flatten
+    end
+
+    def all
+      @locations ||= transform_data(request('/locations')).try(:compact) || []
+    end
+
+    def request(endpoint)
+      user_token = Thread.current[:current_user].try(:authentication_token)
+      url = Settings.location_service.url + "v1/" + endpoint + "?api_key=#{user_token||Settings.location_service.token}"
+      cache.fetch(CACHE_KEY) do
+        logger.debug url
+        JSON.parse(RestClient.get(url))
+      end
+    end
+
+    def reset
+      Rails.cache.delete(CACHE_KEY)
+      @locations = nil
+    end
+
+    def transform_data(data)
+      if data.kind_of? Array
+        data.map { |v| transform_data(v) }
+
+      elsif data.kind_of? Hash
+        #HashWithIndifferentAccess[data.map {|k, v| [k.to_s.underscore, transform_data(v)] }]
+        l = Location.new(*data.values_at(*KEY_ORDER))
+        l.created_at = data['createdAt'] && time.at( data['createdAt']/1000 ) 
+        l.updated_at = data['updatedAt'] && time.at( data['updatedAt']/1000 ) 
+        l.child_locations = transform_data( data['childLocations'] ) || []
+        l
+      else
+        data
+      end
+    end
+
+    def time
+      Time.zone || Time
+    end
+    def cache
+      defined?(Rails) ? Rails.cache : ActiveSupport::Cache::FileStore.new
+    end
+
+    def logger
+      defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+module LocationServiceClient
+  VERSION = "0.1.0".freeze
+
+  def self.version
+    VERSION
+  end
+end

data/location_service_client.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "version"
+#require "location_service_client/"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "location-service-client"
+  s.version     = LocationServiceClient::VERSION
+  s.authors     = ["Josh Buermann"]
+  s.email       = ["josh.buermann@springshot.com"]
+  s.homepage    = "https://github.com/springshot/location_service_client"
+  s.summary     = ""
+  s.description = ""
+  s.license     = ""
+
+  s.files         = `git ls-files`.split("\n").sort
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+
+  s.required_ruby_version = '~> 2.0'
+
+  s.add_dependency "config"
+  s.add_dependency "json"
+  s.add_dependency "rest-client"
+  s.add_dependency "tzinfo"
+  s.add_dependency "activerecord"
+
+  s.add_development_dependency "rspec-rails", '>= 3.0'
+end