singleplatform 0.2.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c145adab5f968aa717643063bfad1482d70ed11e
-  data.tar.gz: d5311c4cb78d5363440580d00dde210609b578bb
+  metadata.gz: 55bb39070469e1543ee041e5af49da520af9cf13
+  data.tar.gz: 6d1cbf1682277c41d6d24e422327cbcf2dc4a90f
 SHA512:
-  metadata.gz: 2717d6cb948eb3732df5f9f1fed81598f83a12019d2d065f60cb8fed4a9293410b617032bab46e4c24f621c6f88aab3ce7f4b5afd99607783fe55d95335b0137
-  data.tar.gz: 919cfa303a3406c364ad532a646012114bb609b1333927502097814a4d9b54b5ae5131dffc7317e400645bcac61cf36ccfd5fc2674e2dab690732ad379543655
+  metadata.gz: 8c8c90b954cf495ba99841c1d690d828a4e71dd8eab71d59db0793791dddf557e750ea76ec10cde748160b8bb863ceccd67aa543eef96ac1c7698547d8e54c16
+  data.tar.gz: a7eb93dba76d7ced5cf66b8fd121aff5229287243a1cab9b41e134cb714d292e69530e97a101836504f365f994f29efe89515af8c6c8d9ec857050e74c596a92

data/.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
 .env
 singleplatform-0.1.0.gem
-singleplatform-0.1.1.gem
+singleplatform-0.1.1.gem
+singleplatform-0.2.2.gem

data/.todo

@@ -0,0 +1,10 @@
+- handle response status codes where not 200 (status code)
+- implement /locations/{id}/all endpoint
+- New response type with iterator (next), which passes path+params to locations_updated_since
+- be defensive, checking for empty/nil
+- add test coverage for Response handling
+- RSpec (nested expecations)
+- Gemcutter
+- CodeClimate
+- TravisCI
+- License file (MIT)

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+env:
+  - CLIENT_ID='abcdefg' CLIENT_SECRET='hijklmn'

data/Gemfile

@@ -3,5 +3,9 @@ source 'https://rubygems.org'
 gem 'bundler'
 gem 'httparty'
 gem 'hashie'
-gem 'rspec'
-gem 'webmock'
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -10,6 +10,7 @@ GEM
     httparty (0.14.0)
       multi_xml (>= 0.5.2)
     multi_xml (0.5.5)
+    rake (11.2.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -31,6 +32,7 @@ DEPENDENCIES
   bundler
   hashie
   httparty
+  rake
   rspec
   webmock
 

data/README.md

@@ -1,6 +1,8 @@
 # SinglePlatform API Ruby Client
 This is a wrapper for accessing SinglePlatform's API. Please see [SinglePlatform's official API documentation](http://docs.singleplatform.com/spv3/) for information on obtaining API credentials.
 
+[![Code Climate](https://codeclimate.com/github/okayjeff/singleplatform/badges/gpa.svg)](https://codeclimate.com/github/okayjeff/singleplatform)
+
 ## Installation
 ```
 gem install singleplatform
@@ -46,6 +48,8 @@ This will return a ```Singleplatform::Response``` object. Access the response bo
 
 ```ruby
 response = client.location('nobu')   # => #<Singleplatform::Response ... >
+response.code                        # => 200
+response.body                        # => #<Hashie::Mash ... >
 response.body.name                   # => "Nobu"
 response.body.attributes             # => #<Hashie::Mash ... >
 response.body.attributes.drive_thru  # => false
@@ -84,9 +88,9 @@ See SinglePlatform's API documentation for the Menu schema with a full list of a
 Many SinglePlatform locations have photos, both at the business and menu-item level. Returns a ```Singleplatform::Response``` object whose body is an Array of menus.
 
 ```ruby
-response = client.photos_for('no')  # => #<Singleplatform::Response ... >
-response.body.first.type            # => "Product"
-response.body.first.url             # => "http://xyz.cloudfront.net/.../39bf7671bc7d006f4cef72d94eee24aeec7615d2.jpg"
+response = client.photos_for('nobu')  # => #<Singleplatform::Response ... >
+response.body.first.type              # => "Product"
+response.body.first.url               # => "http://xyz.cloudfront.net/.../39bf7671bc7d006f4cef72d94eee24aeec7615d2.jpg"
 ```
 
 #### Fetching all photos updated since a given date
@@ -95,5 +99,5 @@ Similarly to ```locations_updated_since```, calling ```photos_updated_since``` r
 
 ````ruby
 response = client.photos_updated_since('2016-09-01')  # => #<Singleplatform::Response ... >
-response
+response.next
 ````

data/Rakefile

@@ -0,0 +1,9 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/singleplatform/client.rb

@@ -27,6 +27,8 @@ module Singleplatform
       raise Error::MissingCredentialsError if credentials_missing?
     end
 
+    private
+
     # Form the complete URL for a given endpoint
     # 
     # @note Signature must be the last parameter
@@ -70,11 +72,9 @@ module Singleplatform
     #
     # @return [Boolean]
     def valid_date?(date)
-      d = date.split('-')
-      d.map! { |d| d.to_i }
-      Date.valid_date?(d[0], d[1], d[2])
-    rescue TypeError
-      return false
+      return false if date.index(/[^-0-9]/)
+      y, m, d = date.to_s.split('-')
+      Date.valid_date?(y.to_i, m.to_i, d.to_i)
     end
   end
 end

data/lib/singleplatform/error.rb

@@ -18,6 +18,12 @@ module Singleplatform
       end
     end
 
+    class RequestError < Base
+      def initialize(msg = "Unable to transmit HTTP request to SinglePlatform.")
+        super
+      end
+    end
+
     class MissingParametersError < Base
       def initialize(msg = "Your request is missing required parameters.")
         super

data/lib/singleplatform/request.rb

@@ -12,13 +12,8 @@ module Singleplatform
       response = HTTParty.get(url)
     rescue
       sleep 3
-      if tries -= 1 > 0
-        retry
-      end
-      raise(
-        Error::RequestError,
-        "Unable to transmit request to SinglePlatform. Try again later or contact technical support."
-      )
+      retry if (tries -= 1) > 0
+      raise Error::RequestError
     else
       raise(
         Error::ApiError,
@@ -27,8 +22,8 @@ module Singleplatform
       Response.new(
         code:   response.code,
         body:   self.parse_response_body(response.body),
-        # Pass the calling method to the Response object so it knows which
-        # method to call when API results are iterable
+        # Pass the calling method to the Response object so Response#next 
+        # knows which method to call when API results are iterable.
         origin: caller_locations(1,1)[0].label
       )
     end

data/lib/singleplatform/response.rb

@@ -12,10 +12,10 @@ module Singleplatform
     end
 
     # An iterator for retrieving the next page of results from
-    #   API response.
+    # API response.
     #
     # @note Will only work with Client#locations_updated_since and
-    #   #photos_updated_since at this time.
+    # #photos_updated_since at this time.
     #
     # @return [Hashie::Mash]
     def next
@@ -26,9 +26,9 @@ module Singleplatform
         client_secret: ENV['CLIENT_SECRET']
       )
       new_page = client.public_send(
-                                    origin.to_sym,
-                                    params.delete('date'), params
-                                    )
+                   origin.to_sym,
+                   params.delete('date'), params
+                 )
       refresh(new_page)
     end
 

data/lib/singleplatform/version.rb

@@ -1,3 +1,3 @@
 module Singleplatform
-  VERSION = '0.2.2'
+  VERSION = '0.3.2'
 end

data/spec/singleplatform/client/locations_spec.rb

@@ -72,6 +72,7 @@ describe 'Singleplatform::Client::Locations' do
         expect { @client.locations_updated_since('2016-9') }.to raise_error(Singleplatform::Error::InvalidDateError)
         expect { @client.locations_updated_since('2016-9-') }.to raise_error(Singleplatform::Error::InvalidDateError)
         expect { @client.locations_updated_since('2016-9-31') }.to raise_error(Singleplatform::Error::InvalidDateError)
+        expect { @client.locations_updated_since('2016-9-3w1') }.to raise_error(Singleplatform::Error::InvalidDateError)
       end
     end
   end

data/spec/singleplatform/client_spec.rb

@@ -26,12 +26,4 @@ describe Singleplatform::Client do
       end
     end
   end
-
-  describe ".generate_url" do
-    context "given a valid path and params" do
-      it "correctly generates a URL" do
-        expect(@client.generate_url(@path, @params)).to eql(@url)
-      end
-    end
-  end
 end

data/spec/singleplatform/response_spec.rb

@@ -0,0 +1,61 @@
+require 'singleplatform'
+require 'webmock/rspec'
+require 'spec_helper'
+
+describe Singleplatform::Response do
+
+  before do
+    @creds = {
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    }
+    ENV['CLIENT_ID'] = @creds[:client_id]
+    ENV['CLIENT_SECRET'] = @creds[:client_secret]
+    @client = Singleplatform::Client.new(@creds)
+    @updated_since = File.open(Dir.pwd + '/spec/support/fixtures/updated_since.json').read
+  end
+
+  describe ".next" do
+    context "when next_page is nil" do
+      it "returns nil" do
+        response = Singleplatform::Response.new(
+          code:      200,
+          body:      nil,
+          origin:    :locations_updated_since,
+          next_page: nil
+        )
+        expect(response.next.nil?).to be
+      end
+    end
+
+    context "when next_page is empty" do
+      it "returns nil" do
+        response = Singleplatform::Response.new(
+          code:      200,
+          body:      nil,
+          origin:    :locations_updated_since,
+          next_page: ''
+        )
+        expect(response.next.nil?).to be
+      end
+    end
+    
+    context "when origin = updated_since" do
+      it "returns updated_since results" do
+        response = Singleplatform::Response.new(
+          code:      200,
+          body:      @updated_since,
+          origin:    :locations_updated_since,
+          next_page: "http://publishing-api.singleplatform.com/locations/updated_since/?date=2016-09-01T00:00:02&limit=2&last_record_id=22494"
+        )
+        stub_request(:get, /publishing-api.singleplatform.com/).
+          with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: @updated_since)
+        next_page = response.next
+        expect(next_page).to be_a(Singleplatform::Response)
+        expect(next_page.body.results.size).to eql(3)
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleplatform
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Jeff Gharakhanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".todo"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -65,6 +67,7 @@ files:
 - spec/singleplatform/client/menus_spec.rb
 - spec/singleplatform/client/photos_spec.rb
 - spec/singleplatform/client_spec.rb
+- spec/singleplatform/response_spec.rb
 - spec/singleplatform_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/location.json
@@ -91,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby client library for accessing the SinglePlatform API.