starline 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 479179b8a62f12f04476cd6ba6f653b9f4d86406
-  data.tar.gz: 925f4f70aa604a3e3ee7250f215a7ccbe83334a8
+  metadata.gz: 53f349bc2281f457996dbeb80828b4ad452d4b80
+  data.tar.gz: 54eca28e8d2dcb42abe550efe43c77d3b53070f9
 SHA512:
-  metadata.gz: fddb071ac90be7118bbd5f4dbcb0d52e8fe6263f89bbe308fa356de00a37a392f1cb245eb304cd25e2f7251a5fa42e87532067736f587c920c4429b94bf3b5c8
-  data.tar.gz: c8774aca9f5724b4b5611d4ecdd28c4dd10639b7efc4921e079ece28e45f273c92a29ca613e550434d3ed9b927b313b18eaf50f90e7ebd4b7031b3021cb96eae
+  metadata.gz: b98b07ee62f96e4ba7e97cb4dfba119a1e22b15f4ee84bea977701bdd61141965091874b5b5f0bd25648c3d1f3102f89eed9b98dd36a9eb1d1ea1c85fd7abfa3
+  data.tar.gz: c83e704c404641de1a4866948a9fbea9a7c5c0044042479e3a8e94a133ac37724f66b96db224860b89dca31bb967aed03185545e948ea99dc82bb4d126de4b24

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 before_install: gem install bundler -v 1.12.5

data/README.md

@@ -1,5 +1,9 @@
 # Starline Telematics
 
+[![Dependency Status](https://gemnasium.com/badges/github.com/sharipov-ru/starline.svg)](https://gemnasium.com/github.com/sharipov-ru/starline)
+[![Code Climate](https://codeclimate.com/github/sharipov-ru/starline/badges/gpa.svg)](https://codeclimate.com/github/sharipov-ru/starline)
+[![Build Status](https://travis-ci.org/sharipov-ru/starline.svg?branch=master)](https://travis-ci.org/sharipov-ru/starline)
+
 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)
@@ -8,6 +12,8 @@ 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 uses [this fastest available & lightweight implementation](https://github.com/paulnsorensen/fast_haversine) of calculating distance between two points by [Haversine formula](https://en.wikipedia.org/wiki/Haversine_formula).
+
 The library is for personal use only and, of course, it doesn't send your data
 anywhere so you can be confident using it.
 
@@ -47,10 +53,10 @@ Get all tracks - connections between geo points:
 telematics.tracks
 ```
 
-Filter out tracks when with zero distance:
+Filter tracks with zero distance:
 
 ```ruby
-telematics.tracks.without_parking_tracks
+telematics.tracks.filter_by_distance(eq: 0)
 ```
 
 ## Development

data/lib/starline/entities/distance_filter.rb

@@ -0,0 +1,74 @@
+module Starline
+  module Entities
+    class DistanceFilter
+      # Supported filter names
+      FILTERS = %i(eq ne gt lt gte lte)
+
+      # Mapping between filter names and its ruby functions
+      OPERATORS = {
+        :eq  => :==,
+        :ne  => :!=,
+        :gt  => :>,
+        :lt  => :<,
+        :gte => :>=,
+        :lte => :<=
+      }
+
+      attr_reader :type, :value
+
+      # Initialize +DistanceFilter+ object from Hash.
+      #
+      # Usage
+      #
+      #   DistanceFilter.new(gt: 5.4)
+      #
+      # Supports only one filter as search parameterfor now.
+      def initialize(search_params_hash)
+        raise_unknown_filter_error if search_params_hash.empty?
+        raise_ambiguous_filter_error if search_params_hash.size > 1
+
+        @type  = search_params_hash.keys.first
+        @value = search_params_hash.values.first
+
+        raise_unknown_filter_error unless supported_filter?
+        raise_invalid_value_error unless valid_value?
+      end
+
+      # Applies filter to a given collection.
+      #
+      # Usage
+      #
+      #   filter.apply_to(tracks)
+      #
+      # Returns a collection with items which satisfy the current filter
+      def apply_to(collection)
+        collection.select { |item| item.distance.send(operator, @value) }
+      end
+
+      private
+      def supported_filter?
+        FILTERS.include?(type)
+      end
+
+      def valid_value?
+        value.is_a?(Numeric)
+      end
+
+      def operator
+        OPERATORS[type]
+      end
+
+      def raise_unknown_filter_error
+        raise ArgumentError, "Filter type is unknown"
+      end
+
+      def raise_ambiguous_filter_error
+        raise ArgumentError, "Multiple search parameters are not supported"
+      end
+
+      def raise_invalid_value_error
+        raise ArgumentError, "Filter value must be numeric typed"
+      end
+    end
+  end
+end

data/lib/starline/entities/tracks_collection.rb

@@ -1,3 +1,5 @@
+require 'starline/entities/distance_filter'
+
 module Starline
   module Entities
     class TracksCollection
@@ -15,8 +17,9 @@ module Starline
         @tracks.size
       end
 
-      def without_parking_tracks
-        @tracks.reject { |track| track.distance == 0 }
+      def filter_by_distance(search_params_hash)
+        filter = DistanceFilter.new(search_params_hash)
+        filter.apply_to(@tracks)
       end
     end
   end

data/lib/starline/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sharipov Ruslan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2017-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_haversine
@@ -105,6 +105,7 @@ files:
 - lib/starline/builders.rb
 - lib/starline/builders/geo_points.rb
 - lib/starline/builders/tracks.rb
+- lib/starline/entities/distance_filter.rb
 - lib/starline/entities/geo_point.rb
 - lib/starline/entities/track.rb
 - lib/starline/entities/tracks_collection.rb