spot-gps 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae8f932cea97f131527f1b2f24b693b21c78bfaa
-  data.tar.gz: 506fa0a9ce404eb350cd8e7847d15b8b0099a49a
+  metadata.gz: dd30beee45ef852e2ef63c83c1671600b1aef085
+  data.tar.gz: fe3e6c3dc00cd6f8ccf2fe00955c121be5919009
 SHA512:
-  metadata.gz: c81515b2b992f025958fbbd3de61d9fb06b6cab5d8b48c2e10bfde32d072beb2cb9808c6a6761cd4d2fb5e8f501689715f771d24d98e006872256d8113fac7f9
-  data.tar.gz: daad07e097b8decddb8c78adfd9c95b1804dabb0839108a9e5d0a3c5ca524d3768221b4c1975cc67deb963773f1cb3c196924a5b86f55b382c0b392889eabce4
+  metadata.gz: b9807c61a995b52a9b6ec8cf36ffd10d43b87b222a6b87096216ed0e7e3e90b0abf6e2564ac03c0cc28372b13bf34cbff12d8a894a270527a3220be426677f83
+  data.tar.gz: 3794197c9ca65049abefb6483409f5b627fd83d697cb525d7c0a8728145778994794971347ffd6cce1ed8ba67f388e8f18cd6cc1c7b21c22b061bbf47f997fbe

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.2.0, 11 July 2016
+
+- `#to_h` now returns a resources cleaned attributes, not its initial input
+- Add `#to_raw_h` method to SPOT::Resources::Message, which replaces `#to_h`
+- Make `#response` available on ListResponse, and document it
+
 ## v0.1.0, 10 July 2016
 
 - Move old `all` functionality to `list`

data/README.md

@@ -15,7 +15,8 @@ gem 'spot-gps'
 
 ## Configuration
 
-There are 3 configuration options:
+Timeout options can be configured globally, or you can rely on the default
+values below:
 
 ```ruby
 SPOT.configure do |config|
@@ -26,7 +27,7 @@ end
 
 ## Usage
 
-API calls are made using an instance of the `API` class:
+API calls are made using an instance of the `SPOT::Client` class:
 
 ```ruby
 api = SPOT::Client.new(feed_id: 'FEED_GIID', feed_password: 'OPTIONAL_PASSWORD')
@@ -34,7 +35,7 @@ api = SPOT::Client.new(feed_id: 'FEED_GIID', feed_password: 'OPTIONAL_PASSWORD')
 
 ### Resources
 
-Currently, the SPOT API only supports a single `messages` resource.
+Currently, the SPOT API only supports the `messages` resource.
 
 #### Messages
 
@@ -46,6 +47,28 @@ api.messages.list    # => Returns a list of messages for a given page of a feed
 api.messages.latest  # => Returns the most recent message for a feed
 ```
 
+Each message has the following details available:
+
+```ruby
+message = api.messages.latest
+
+message.id                    # => Integer. ID of the SPOT message
+message.created_at            # => Time
+message.type                  # => String. Message type (e.g., "OK", or "HELP")
+message.latitude              # => Float
+message.longitude             # => Float
+message.battery_state         # => String. Battery state at time of sending (e.g., "GOOD")
+message.hidden                # => Boolean. I'm not sure what this is for...
+message.show_custom_message   # => Boolean. I'm not sure what this is for...
+message.content               # => String
+message.messenger_id          # => String. As used when registering your SPOT
+message.messenger_name        # => String. As specified when registering your SPOT
+message.messenger_model       # => String. E.g., "SPOT3"
+```
+
+You can also call `#to_h` on a message to get its (cleaned) attributes as a
+hash, or `#to_raw_h` to get the attributes as returned by SPOT.
+
 ### Pagination
 
 If you want to get all of the records for a given resource type, you can use the
@@ -66,17 +89,37 @@ api.messages.list(page: 2)
 
 ### Filtering
 
-The SPOT API supports filtering by date.
+The SPOT API only supports filtering by date. You can do so using either the
+`#list` or `#all` methods.
 
 ```ruby
+api.messages.all(start_at: '2014-06-01T00:00:00', end_at: '2015-06-01T00:00:00')
 api.messages.list(start_at: '2014-06-01T00:00:00', end_at: '2015-06-01T00:00:00')
 ```
 
+You can pass the `start_at` and `end_at` parameters as a `String`, `Time`,
+`DateTime` or `Date`, and the gem will handle formatting it correctly for SPOT.
+
+### Raw responses
+
+If you'd like to query the un-wrapped response data from SPOT, you can use the
+`#response` method to do so.
+
+```ruby
+message = api.messages.latest
+response = message.response
+
+response.body         # => Hash. JSON body
+response.headers      # => Hash. Headers returned by SPOT
+response.status       # => Integer. Status code returned by SPOT
+```
+
 ### Error Handling
 
 TODO: Currently the gem will just raise Faraday errors if anything goes wrong
 with a request.
 
+
 ## Contributing
 
 1. Fork it ( https://github.com/greysteil/spot-gps/fork )

data/lib/spot-gps/list_response.rb

@@ -16,5 +16,9 @@ module SPOT
         @resource_class.new(item)
       end
     end
+
+    def response
+      @response
+    end
   end
 end

data/lib/spot-gps/resources/message.rb

@@ -14,33 +14,48 @@ module SPOT
       attr_reader :messenger_name
       attr_reader :messenger_model
 
-      def initialize(object, response = nil)
-        @object = object
+      attr_reader :response
 
+      def initialize(object, response = nil)
         @id = object.fetch('id')
         @created_at = Time.at(object.fetch('unixTime'))
         @type = object.fetch('messageType')
         @latitude = object.fetch('latitude')
         @longitude = object.fetch('longitude')
         @battery_state = object.fetch('batteryState')
+        @hidden = object.fetch('hidden') == 1
+        @show_custom_message = object.fetch('showCustomMsg') == "Y"
+        @content = object.fetch('messageContent')
+        @messenger_id = object.fetch('messengerId')
+        @messenger_name = object.fetch('messengerName')
+        @messenger_model = object.fetch('modelId')
 
-        @hidden = object['hidden'] == 1
-        @show_custom_message = object['showCustomMsg'] == "Y"
-        @content = object['messageContent']
-        @messenger_id = object['messengerId']
-        @messenger_name = object['messengerName']
-        @messenger_model = object['modelId']
-
+        @object = object
         @response = response
       end
 
-      def response
-        @response
+      def to_h
+        @hash ||=
+          begin
+            attribute_ivars =
+              (instance_variables - [:@response, :@object, :@hash])
+
+            attribute_ivars.each_with_object({}) do |ivar, hash|
+              hash[ivar.to_s.delete('@').to_sym] = instance_variable_get(ivar)
+            end
+          end
       end
 
-      def to_h
+      def to_raw_h
         @object
       end
+
+      def inspect
+        attr_list =
+          to_h.map { |key, value| "#{key}: #{value.inspect}" }.join(', ')
+
+        "#<#{self.class} #{attr_list}>"
+      end
     end
   end
 end

data/lib/spot-gps/version.rb

@@ -1,3 +1,3 @@
 module SPOT
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/api_response_spec.rb

@@ -15,6 +15,7 @@ describe SPOT::ApiResponse do
   end
 
   its(:status) { is_expected.to eq(200) }
+  its(:headers) { is_expected.to be_a(Hash) }
 
   describe "#body" do
     context "when the response is JSON" do

data/spec/fixtures/message.json

@@ -3,7 +3,7 @@
         "feedMessageResponse": {
             "count": 2,
             "feed": {
-                "id": "1HXUWlonx0AInTM7LAnBoAFEBQ9GWLJ5e",
+                "id": "FEED_ID",
                 "name": "Testing",
                 "description": "Testing",
                 "status": "ACTIVE",

data/spec/resources/message_spec.rb

@@ -22,7 +22,7 @@ describe SPOT::Resources::Message do
     end
 
     it 'can be initialized from an unenveloped response' do
-      resource = described_class.new(data)
+      resource = described_class.new(data, nil)
 
       expect(resource.id).to eq(585079373)
       expect(resource.created_at).to eq(Time.at(1468164566))
@@ -40,13 +40,39 @@ describe SPOT::Resources::Message do
 
     it 'can handle new attributes without erroring' do
       data['foo'] = 'bar'
-      expect { described_class.new(data) }.to_not raise_error
+      expect { described_class.new(data, nil) }.to_not raise_error
     end
 
     describe '#to_h' do
-      it 'returns a hash representing the resource' do
-        expect(described_class.new(data).to_h).to eq(data)
+      subject { described_class.new(data, nil).to_h }
+      let(:expected_hash) do
+        {
+          id: 585079373,
+          created_at: Time.at(1468164566),
+          type: 'OK',
+          latitude: 61.54875,
+          longitude: -3.0697,
+          battery_state: 'GOOD',
+          hidden: false,
+          show_custom_message: true,
+          content: 'Example SPOT message.',
+          messenger_id: '0-1234567',
+          messenger_name: 'My SPOT',
+          messenger_model: 'SPOT3'
+        }
       end
+
+      it { is_expected.to eq(expected_hash) }
+    end
+
+    describe '#to_aw_h' do
+      subject { described_class.new(data, nil).to_raw_h }
+      it { is_expected.to eq(data) }
+    end
+
+    describe '#response' do
+      subject { described_class.new(data, "response").response }
+      it { is_expected.to eq("response") }
     end
   end
 end

data/spec/services/messages_spec.rb

@@ -76,6 +76,7 @@ describe SPOT::Services::Messages do
       end
 
       it { is_expected.to be_a(SPOT::ListResponse) }
+      its(:response) { is_expected.to be_a(SPOT::ApiResponse) }
       its("records.first") { is_expected.to be_a(SPOT::Resources::Message) }
 
       context "when there are no displayable messages" do
@@ -196,6 +197,7 @@ describe SPOT::Services::Messages do
   end
 
   describe "#latest" do
+    subject { messages.latest }
     before do
       stub_url = SPOT.endpoint + 'EXAMPLE_ID/latest.json'
       stub_request(:get, stub_url).to_return(
@@ -213,8 +215,7 @@ describe SPOT::Services::Messages do
       messages.latest
     end
 
-    it 'wraps the response in a resource' do
-      expect(messages.latest).to be_a(SPOT::Resources::Message)
-    end
+    it { is_expected.to be_a(SPOT::Resources::Message) }
+    its(:response) { is_expected.to be_a(SPOT::ApiResponse) }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spot-gps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-10 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock