starline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 479179b8a62f12f04476cd6ba6f653b9f4d86406
+  data.tar.gz: 925f4f70aa604a3e3ee7250f215a7ccbe83334a8
+SHA512:
+  metadata.gz: fddb071ac90be7118bbd5f4dbcb0d52e8fe6263f89bbe308fa356de00a37a392f1cb245eb304cd25e2f7251a5fa42e87532067736f587c920c4429b94bf3b5c8
+  data.tar.gz: c8774aca9f5724b4b5611d4ecdd28c4dd10639b7efc4921e079ece28e45f273c92a29ca613e550434d3ed9b927b313b18eaf50f90e7ebd4b7031b3021cb96eae

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sharipov.ru@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sharipov Ruslan
+
+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,70 @@
+# Starline Telematics
+
+StarlineTelematics is a ruby library-wrapper over telematics JSON data from
+satellite security and monitoring service which is used in StarLine car alarm
+systems (https://starline-online.ru)
+
+The purpose of the library is to provide easy way for getting your car tracks
+data and present them in usable format for further analyzing / building 
+applications around it.
+
+The library is for personal use only and, of course, it doesn't send your data
+anywhere so you can be confident using it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'starline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install starline
+
+## Usage
+
+Read JSON files:
+
+```ruby
+telematics = StarLine::Telematics.new(track_file_path)    
+```
+
+Get GeoPoint objects:
+
+```ruby
+telematics.geo_points
+```
+
+Get all tracks - connections between geo points:
+
+```ruby
+telematics.tracks
+```
+
+Filter out tracks when with zero distance:
+
+```ruby
+telematics.tracks.without_parking_tracks
+```
+
+## 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 tags, 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/sharipov-ru/starline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "starline"
+
+# 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

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/starline.rb

@@ -0,0 +1,5 @@
+require "starline/version"
+require "starline/telematics"
+
+module Starline
+end

data/lib/starline/builders.rb

@@ -0,0 +1,7 @@
+require 'starline/builders/geo_points'
+require 'starline/builders/tracks'
+
+module Starline
+  module Builders
+  end
+end

data/lib/starline/builders/geo_points.rb

@@ -0,0 +1,22 @@
+require 'starline/entities/geo_point'
+
+module Starline
+  module Builders
+    class GeoPoints
+      def self.build(tracks_json)
+        points = tracks_json.fetch("desc")
+        points.map { |point_hash| build_geo_point(point_hash) }
+      end
+
+      private
+      def self.build_geo_point(hash)
+        Entities::GeoPoint.new(
+          lat: hash["y"],
+          lon: hash["x"],
+          timestamp: hash["ts"]
+        )
+      end
+    end
+  end
+end
+

data/lib/starline/builders/tracks.rb

@@ -0,0 +1,36 @@
+require 'fast_haversine'
+require 'starline/entities/track'
+require 'starline/entities/tracks_collection'
+
+module Starline
+  module Builders
+    class Tracks
+      def self.build(geo_points)
+        tracks = []
+
+        geo_points.each_cons(2) do |start_point, end_point|
+          tracks << build_track(start_point, end_point)
+        end
+
+        Entities::TracksCollection.new(tracks)
+      end
+
+      private
+      def self.build_track(start_point, end_point)
+        Entities::Track.new(
+          start_point: start_point,
+          end_point: end_point,
+          distance: calculate_distance(start_point, end_point)
+        )
+      end
+
+      def self.calculate_distance(start_point, end_point)
+        FastHaversine.distance_between(
+          [start_point.lat, start_point.lon],
+          [end_point.lat, end_point.lon],
+          :km
+        )
+      end
+    end
+  end
+end

data/lib/starline/entities/geo_point.rb

@@ -0,0 +1,13 @@
+module Starline
+  module Entities
+    class GeoPoint
+      attr_reader :lat, :lon, :timestamp
+
+      def initialize(lat:, lon:, timestamp:)
+        @lat = lat
+        @lon = lon
+        @timestamp = timestamp
+      end
+    end
+  end
+end

data/lib/starline/entities/track.rb

@@ -0,0 +1,13 @@
+module Starline
+  module Entities
+    class Track
+      attr_reader :start_point, :end_point, :distance
+
+      def initialize(start_point:, end_point:, distance:)
+        @start_point = start_point
+        @end_point = end_point
+        @distance = distance
+      end
+    end
+  end
+end

data/lib/starline/entities/tracks_collection.rb

@@ -0,0 +1,23 @@
+module Starline
+  module Entities
+    class TracksCollection
+      include Enumerable
+
+      def initialize(tracks)
+        @tracks = tracks
+      end
+
+      def each(&block)
+        @tracks.each(&block)
+      end
+
+      def size
+        @tracks.size
+      end
+
+      def without_parking_tracks
+        @tracks.reject { |track| track.distance == 0 }
+      end
+    end
+  end
+end

data/lib/starline/telematics.rb

@@ -0,0 +1,30 @@
+require 'starline/builders'
+require 'json'
+
+module Starline
+  class Telematics
+    attr_reader :tracks_path
+
+    def initialize(tracks_path)
+      @tracks_path = File.expand_path(tracks_path)
+    end
+    
+    def tracks_file
+      File.open(tracks_path)
+    end
+
+    def geo_points
+      Starline::Builders::GeoPoints.build(parsed_tracks_file)
+    end
+
+    def tracks
+      Starline::Builders::Tracks.build(geo_points)
+    end
+
+    private
+
+    def parsed_tracks_file
+      JSON.parse(File.read(tracks_file))
+    end
+  end
+end

data/lib/starline/version.rb

@@ -0,0 +1,3 @@
+module Starline
+  VERSION = "0.1.0"
+end

data/starline.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'starline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "starline"
+  spec.version       = Starline::VERSION
+  spec.authors       = ["Sharipov Ruslan"]
+  spec.email         = ["sharipov.ru@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for JSON data from StarLine website.}
+  spec.description   = %q{StarlineTelematics is a ruby library-wrapper over telematics JSON data from
+satellite security and monitoring service which is used in StarLine car alarm
+systems (https://starline-online.ru)}
+  spec.homepage      = "https://github.com/sharipov-ru/starline_telematics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fast_haversine", "0.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: starline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sharipov Ruslan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fast_haversine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+description: |-
+  StarlineTelematics is a ruby library-wrapper over telematics JSON data from
+  satellite security and monitoring service which is used in StarLine car alarm
+  systems (https://starline-online.ru)
+email:
+- sharipov.ru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/starline.rb
+- lib/starline/builders.rb
+- lib/starline/builders/geo_points.rb
+- lib/starline/builders/tracks.rb
+- lib/starline/entities/geo_point.rb
+- lib/starline/entities/track.rb
+- lib/starline/entities/tracks_collection.rb
+- lib/starline/telematics.rb
+- lib/starline/version.rb
+- starline.gemspec
+homepage: https://github.com/sharipov-ru/starline_telematics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for JSON data from StarLine website.
+test_files: []