supreme_golf 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d8034d9b3c8a36628cab31faea0a239335ae566
-  data.tar.gz: 22a00ed433bd8fe552f8ca1a1769c619c07ed705
+  metadata.gz: 866941e1cc02bf2d66290a4131d6ee4c50da178b
+  data.tar.gz: c02371f65c665575a3b376eadcc02daab791ac27
 SHA512:
-  metadata.gz: ac9c7a1f05359937d6931471152b1069a0536ea998d08b0a1d52f6949c225de9df28d35aa13dcc2c7ca6f89a7aad9714d957a8cde6bd99ca87bdfb5244f75642
-  data.tar.gz: 01047920917e098fcf81d1f03afdc0d9226861cad6cf90f8ccb9c54ac08c895f70f1e44ff7c0b58ea37c228f481affe2beb31ceb751265076502558830eb000c
+  metadata.gz: a3501a060b56eaf6fb25b28b3d21ce71b47e4a08009bb7fdb17632a70d9720cd1812d7ba634fb9359508cb16e1c2a2c7661897010058f09865adfc7e62569e08
+  data.tar.gz: bca741f2149ef410a2269cfa23cf3db0849507a568a6ee99a510a4ace85f60046b3503d33560cd0d12b7e0162a72b87bad20ffe18fbec54704208a9fb908ed8e

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in supreme-golf.gemspec
+# Specify your gem's dependencies in supreme_golf.gemspec
 gemspec

data/README.md

@@ -4,7 +4,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'supreme-golf'
+    gem 'supreme_golf'
 
 And then execute:
 
@@ -12,19 +12,22 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install supreme-golf
+    $ gem install supreme_golf
 
 ## Official docs
 
     https://supremegolf.com/api/docs/
 
+## Configuration
+
+    SupremeGolf.configure do |config|
+      config.x_api_key = 'your-api-key-here'
+    end
+
 ## Usage
 
 The "params" passed to the API methods are simply the parameters defined in the official documentation listed above.
 
-    # Require the gem
-    require 'supreme_golf'
-
     # Get all courses near a lat/lon
     SupremeGolf::Course.near(params: {lat: 33.4677096, lon: -117.1318014, limit: 1})
 
@@ -42,7 +45,7 @@ The "params" passed to the API methods are simply the parameters defined in the
 
 You're welcome to contribute and help flesh out the rest of the API. I only implemented the methods I needed for my specific case, but there are many more you can see from the official docs.
 
-1. Fork it ( https://github.com/[my-github-username]/supreme-golf/fork )
+1. Fork it ( https://github.com/[my-github-username]/supreme_golf/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/supreme_golf/base.rb

@@ -10,5 +10,13 @@ module SupremeGolf
       conn = Faraday.get url, params, SupremeGolf.configuration.http_headers
       JSON.parse(conn.body)
     end
+
+    def self.find id
+      response = self.response_from_api "#{self::API_URLS[:find]}/#{id}"
+      key = self.name.split('::').last.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
+
+      raise 'RecordNotFound' unless response[key]
+      new(response[key])
+    end
   end
 end

data/lib/supreme_golf/course.rb

@@ -1,7 +1,9 @@
 module SupremeGolf
   class Course < SupremeGolf::Base
-    FIND_URL = "#{SupremeGolf::API_BASE_URL}/courses"
-    NEAR_URL = "#{SupremeGolf::API_BASE_URL}/courses/near"
+    API_URLS = {
+      find:           "#{SupremeGolf::API_BASE_URL}/courses",
+      near:           "#{SupremeGolf::API_BASE_URL}/courses/near"
+    }
 
     ATTRS = [:id,
       :slug,
@@ -38,15 +40,8 @@ module SupremeGolf
     ]
     attr_accessor *ATTRS
 
-    def self.find id
-      response = self.response_from_api "#{FIND_URL}/#{id}"
-
-      raise 'RecordNotFound' unless response['course']
-      new(response['course'])
-    end
-
     def self.near params: {}
-      response = self.response_from_api NEAR_URL, params
+      response = self.response_from_api API_URLS[:near], params
 
       response['courses'].map do |course_params|
         new(course_params)

data/lib/supreme_golf/tee_time.rb

@@ -1,7 +1,10 @@
 module SupremeGolf
   class TeeTime < SupremeGolf::Base
-    AT_URL = "#{SupremeGolf::API_BASE_URL}/tee_times/at"
-    VALID_URL = "#{SupremeGolf::API_BASE_URL}/tee_times"
+    API_URLS = {
+      find:         "#{SupremeGolf::API_BASE_URL}/tee_times",
+      at:           "#{SupremeGolf::API_BASE_URL}/tee_times/at",
+      valid:        "#{SupremeGolf::API_BASE_URL}/tee_times"
+    }
 
     ATTRS = [:id,
       :course_id,
@@ -19,7 +22,7 @@ module SupremeGolf
     attr_accessor *ATTRS
 
     def self.at course_id, params: {}
-      response = self.response_from_api "#{AT_URL}/#{course_id}", params
+      response = self.response_from_api "#{API_URLS[:at]}/#{course_id}", params
 
       response['tee_times'].map do |tee_time_params|
         new(tee_time_params)
@@ -27,7 +30,7 @@ module SupremeGolf
     end
 
     def self.valid id, params: {}
-      response = self.response_from_api "#{VALID_URL}/#{id}/valid", params
+      response = self.response_from_api "#{API_URLS[:valid]}/#{id}/valid", params
 
       response['reservation_url']
     end

data/lib/supreme_golf/version.rb

@@ -1,3 +1,3 @@
 module SupremeGolf
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/supreme_golf.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rake'
 
   spec.add_dependency 'faraday'
   spec.add_dependency 'json'

data/test/fixtures/find_tee_time.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://supremegolf.com/api/v4/tee_times/367049106
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '341'
+      Connection:
+      - close
+      Status:
+      - 200 OK
+      X-Api-Version:
+      - 4.1.7
+      Access-Control-Allow-Origin:
+      - "*"
+      Etag:
+      - W/"8ae4d3114a5b3c942f281d27d1491737"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - f45acb24-7d10-4c9a-b409-6b5aead73382
+      X-Runtime:
+      - '0.013376'
+      Vary:
+      - Origin
+      X-Powered-By:
+      - Phusion Passenger 4.0.59
+      Date:
+      - Tue, 02 Jun 2015 17:06:51 GMT
+      Server:
+      - nginx + Phusion Passenger 4.0.59
+    body:
+      encoding: UTF-8
+      string: '{"tee_time":{"id":367049106,"course_id":3003,"currency":"USD","players":[1,2,3,4],"rate":"65.00","regular_rate":"80.52","savings_pct":19,"savings_amount":"15.52","tee_off_at_formatted":"10:10AM","tee_off_at_iso8601":"2015-06-02T10:10:00Z","amenities":["is_18_holes","is_riding"],"provider":{"code":"golf18_network","name":"Golf18
+        Network"}}}'
+    http_version: 
+  recorded_at: Tue, 02 Jun 2015 17:06:51 GMT
+recorded_with: VCR 2.9.3

data/test/supreme_golf/course_test.rb

@@ -1,3 +1,4 @@
+require 'minitest/autorun'
 require './test/test_helper'
 
 class SupremeGolfCourseTest < Minitest::Test

data/test/supreme_golf/supreme_golf_test.rb

@@ -8,8 +8,21 @@ class SupremeGolfTest < Minitest::Test
       end
     end
 
+    after do
+      SupremeGolf.configure do |config|
+        config.x_api_key = nil
+      end
+    end
+
     it 'should use x_api_key in request header' do
-      Faraday.expects(:get).with("#{SupremeGolf::Course::FIND_URL}/3002", {}, {'X-Api-Key' => 'testkey'}).returns(stub(body: {course: {}}.to_json))
+      Faraday.expects(:get).with("#{SupremeGolf::Course::API_URLS[:find]}/3002", {}, {'X-Api-Key' => 'testkey'}).returns(stub(body: {course: {}}.to_json))
+      SupremeGolf::Course.find(3002)
+    end
+  end
+
+  describe 'find' do
+    it 'should make request with API_URLS :find and id' do
+      Faraday.expects(:get).with("#{SupremeGolf::Course::API_URLS[:find]}/3002", {}, {}).returns(stub(body: {course: {}}.to_json))
       SupremeGolf::Course.find(3002)
     end
   end

data/test/supreme_golf/tee_time_test.rb

@@ -65,4 +65,41 @@ class SupremeGolfTeeTimeTest < Minitest::Test
       end
     end
   end
+
+  describe 'find' do
+    it 'gives back expected info' do
+      VCR.use_cassette('find_tee_time') do
+        tee_time = SupremeGolf::TeeTime.find '367049106'
+
+        expected_values = {
+          id: 367049106,
+          course_id: 3003,
+          currency: "USD",
+          players: [
+            1,
+            2,
+            3,
+            4
+          ],
+          rate: "65.00",
+          regular_rate: "80.52",
+          savings_pct: 19,
+          savings_amount: "15.52",
+          tee_off_at_formatted: "10:10AM",
+          tee_off_at_iso8601: "2015-06-02T10:10:00Z",
+          amenities: [
+            "is_18_holes",
+            "is_riding"
+          ],
+          provider: {
+            "code" => "golf18_network",
+            "name" => "Golf18 Network"
+          }
+        }
+        expected_values.each do |attr, value|
+          assert_equal value, tee_time.send(attr), "#{attr} accesses value"
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supreme_golf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kyle Peyton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,7 @@ files:
 - supreme_golf.gemspec
 - test/fixtures/course_find.yml
 - test/fixtures/courses_near.yml
+- test/fixtures/find_tee_time.yml
 - test/fixtures/tee_time_at.yml
 - test/fixtures/tee_time_invalid.yml
 - test/fixtures/tee_time_valid.yml
@@ -162,6 +177,7 @@ summary: Gem to wrap supremegolf.com API
 test_files:
 - test/fixtures/course_find.yml
 - test/fixtures/courses_near.yml
+- test/fixtures/find_tee_time.yml
 - test/fixtures/tee_time_at.yml
 - test/fixtures/tee_time_invalid.yml
 - test/fixtures/tee_time_valid.yml