motion-locman 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6f0fe017e53fd5fd42b7e8da965f5bba50c2121
-  data.tar.gz: d5f238ed5ec67fb62ae601e1b7583531c53d5006
+  metadata.gz: d10b5eb84ea2563bcdf3855ac254eb7c1a85d0f2
+  data.tar.gz: a8a2d3c27c772c9821d05551b734db70184955ba
 SHA512:
-  metadata.gz: f9754fb1ce8504df4425f02607d52a294a7bdca82e09da8f001aaefeaaf90bc51913cb51fc0f43066f1800e57f333132001270290024f9f7a9b770c6fddc8662
-  data.tar.gz: d329b7070fddcb2db215b4c07181663efd1e0f9b3527acb944b336272b885537d1079061407dcd66da61eeaa16e2b1652ef74e29ddfb93a634b9cc291e986c13
+  metadata.gz: 989c5daccea667c113e2b9905b7e551e32cfc278210930a28633ad83bb111281d112073b2679acacb758374579d9f5409136cd2d987e8d6f341646de247ca910
+  data.tar.gz: 9a67a845e19079d6a1770c25781e24904cceb74c3031fef5af60c6dbd6b2a722347f3e1e61e115f8dd4845d39f016f170788f0821bdb8a6e9fe336cdd4fd7574

data/lib/locman/location.rb

@@ -1,9 +1,30 @@
 module Locman
+  # This represents a single location point.
   class Location
-    attr_accessor :latitude, :longitude, :altitude, :floor,
-                  :accuracy, :altitude_accuracy,
-                  :determined_at
+    # @return [Float] Latitude coordinate of the location.
+    attr_accessor :latitude
 
+    # @return [Float] Longitude coordinate of the location
+    attr_accessor :longitude
+
+    # @return [Float] Altitude distance measurement of the location, in meters.
+    attr_accessor :altitude
+
+    # @return [Integer] The logical floor of the building.
+    attr_accessor :floor
+
+    # @return [Float] Latitude and longitude measurement accuracy, in meters.
+    attr_accessor :accuracy
+
+    # @return [Float] Altitude measurement accuracy, in meters.
+    attr_accessor :altitude_accuracy
+
+    # @return [Time] The time at which this location was determined
+    attr_accessor :determined_at
+
+    # Creates a new Locman::Location instance from CLLocation object.
+    # @param cl_location [CLLocation]
+    # @return [Locman::Location]
     def self.create_from_cl_location(cl_location)
       Locman::Location.new(
         latitude: cl_location.coordinate.latitude,
@@ -16,8 +37,12 @@ module Locman
       )
     end
 
-    def initialize(params = {})
-      params.each { |key, value| send("#{key}=", value) }
+    # Creates a new Locman::Location instance.
+    # @param options [Hash] Attributes that will be assigned on instance creation
+    # @return [Locman::Location]
+    def initialize(options = {})
+      options.each { |key, value| send("#{key}=", value) }
+      self
     end
   end
 end

data/lib/locman/manager.rb

@@ -1,19 +1,36 @@
 module Locman
+  # This wraps CLLocationManager in more Ruby way.
   class Manager
-    attr_accessor :accuracy, :distance_filter, :on_update, :on_error
+    # @return [Symbol] Desired accuracy of the location data.
+    attr_accessor :accuracy
 
+    # @return [Integer] The minimum horizontal distance threshold for on_update event.
+    attr_accessor :distance_filter
+
+    # @return [Proc] Proc function that will be called when there is a new location retrieval.
+    attr_accessor :on_update
+
+    # @return [Proc] Proc function that will be called when there is an error while retrieving the location.
+    attr_accessor :on_error
+
+    # @return [Proc] Proc function that will be called when there is a new visit event.
+    attr_accessor :on_visit
+
+    # @!visibility private
     AUTHORIZED_CONSTS = [
       KCLAuthorizationStatusAuthorized,
       KCLAuthorizationStatusAuthorizedAlways,
       KCLAuthorizationStatusAuthorizedWhenInUse
     ]
 
+    # @!visibility private
     NOT_AUTHORIZED_CONSTS = [
       KCLAuthorizationStatusNotDetermined,
       KCLAuthorizationStatusRestricted,
       KCLAuthorizationStatusDenied
     ]
 
+    # @!visibility private
     ACCURACY_MAP = {
       navigation: KCLLocationAccuracyBestForNavigation,
       best: KCLLocationAccuracyBest,
@@ -23,13 +40,20 @@ module Locman
       three_kilometers: KCLLocationAccuracyThreeKilometers
     }
 
+    # Creates a new Locman::Location instance.
+    # @param options [Hash] Attributes that will be assigned on instance creation
+    # @return [Locman::Manager]
     def initialize(params = {})
       params.each { |key, value| send("#{key}=", value) }
 
       @accuracy ||= :best
       @distance_filter ||= 0
+
+      self
     end
 
+    # Sets a desired accuracy.
+    # @param accuracy [Symbol] Desired accuracy of the location data.
     def accuracy=(accuracy)
       fail(ArgumentError, "Invalid accuracy: #{accuracy}") if ACCURACY_MAP[accuracy].nil?
       @accuracy = accuracy
@@ -78,6 +102,14 @@ module Locman
       manager.startMonitoringSignificantLocationChanges
     end
 
+    def start_monitor_visits!
+      manager.startMonitoringVisits
+    end
+
+    def stop_monitor_visits!
+      manager.stopMonitoringVisits
+    end
+
     def stop_monitor!
       manager.stopMonitoringSignificantLocationChanges
     end
@@ -92,6 +124,11 @@ module Locman
       @on_error = on_error
     end
 
+    def on_visit=(on_visit)
+      fail(ArgumentError, "Must provide proc") unless on_error.is_a?(Proc)
+      @on_visit = on_visit
+    end
+
     # Delegates
 
     def locationManager(manager, didChangeAuthorizationStatus: status)
@@ -110,6 +147,12 @@ module Locman
       @on_update.call(locations) unless @on_update.nil?
     end
 
+    def locationManager(manager, didVisit: cl_visit)
+      visit = Locman::Visit.create_from_cl_visit(cl_visit)
+
+      @on_visit.call(visit) unless @on_visit.nil?
+    end
+
     private
 
     def manager

data/lib/locman/visit.rb

@@ -0,0 +1,27 @@
+module Locman
+  # This represents a single visit.
+  class Visit
+    attr_accessor :latitude, :longitude, :departed_at, :arrived_at
+
+    # Creates a new Locman::Location instance from CLVisit object.
+    # @param cl_visit [CLVisit]
+    # @return [Locman::Location]
+    def self.create_from_cl_visit(cl_visit)
+      Locman::Visit.new(
+        latitude: cl_visit.coordinate.latitude,
+        longitude: cl_visit.coordinate.longitude,
+        departed_at: cl_visit.departureDate,
+        arrived_at: cl_visit.arrivalDate
+      )
+    end
+
+    # Creates a new Locman::Location instance.
+    # @param options [Hash] Attributes that will be assigned on instance creation
+    # @return [Locman::Location]
+    def initialize(options = {})
+      options.each { |key, value| send("#{key}=", value) }
+      self
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-locman
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Minku Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-05 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -35,6 +35,7 @@ files:
 - lib/locman.rb
 - lib/locman/location.rb
 - lib/locman/manager.rb
+- lib/locman/visit.rb
 - lib/motion-locman.rb
 homepage: https://github.com/premist/motion-locman
 licenses:
@@ -61,3 +62,4 @@ signing_key:
 specification_version: 4
 summary: Simple location library for Rubymotion. Wraps CLLocationManager and more.
 test_files: []
+has_rdoc: