teamsnap_rb 0.0.4 → 0.0.5

data/spec/fixtures/cassettes/teams.yml

@@ -0,0 +1,160 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3003/teams
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      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/vnd.collection+json
+      Content-Length:
+      - '2809'
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4999'
+      X-Ratelimit-Reset:
+      - '1415740100'
+      Etag:
+      - '"5daf3cf1d2f681f9ce53cdea0e70b9fb"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - b700c77f-a114-4cfb-b682-df629213ff22
+      X-Runtime:
+      - '0.062563'
+      Server:
+      - WEBrick/1.3.1 (Ruby/2.1.1/2014-02-24)
+      Date:
+      - Tue, 11 Nov 2014 20:08:20 GMT
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"collection":{"version":"3.1.1","href":"http://localhost:3003/teams","template":{"data":[{"name":"name","value":null},{"name":"location_country","value":null},{"name":"location_postal_code","value":null},{"name":"time_zone","value":null},{"name":"sport_id","value":null},{"name":"division_name","value":null},{"name":"season_name","value":null},{"name":"league_name","value":null},{"name":"league_url","value":null}]},"links":[{"rel":"active_season_team","href":"http://localhost:3003/teams"},{"rel":"assignments","href":"http://localhost:3003/assignments"},{"rel":"availabilities","href":"http://localhost:3003/availabilities"},{"rel":"contact_email_addresses","href":"http://localhost:3003/contact_email_addresses"},{"rel":"contact_phone_numbers","href":"http://localhost:3003/contact_phone_numbers"},{"rel":"contacts","href":"http://localhost:3003/contacts"},{"rel":"custom_data","href":"http://localhost:3003/custom_data"},{"rel":"custom_fields","href":"http://localhost:3003/custom_fields"},{"rel":"events","href":"http://localhost:3003/events"},{"rel":"locations","href":"http://localhost:3003/locations"},{"rel":"managers","href":"http://localhost:3003/members"},{"rel":"member_email_addresses","href":"http://localhost:3003/member_email_addresses"},{"rel":"member_files","href":"http://localhost:3003/member_files"},{"rel":"member_links","href":"http://localhost:3003/member_links"},{"rel":"member_phone_numbers","href":"http://localhost:3003/member_phone_numbers"},{"rel":"members","href":"http://localhost:3003/members"},{"rel":"members_preferences","href":"http://localhost:3003/members_preferences"},{"rel":"opponents","href":"http://localhost:3003/opponents"},{"rel":"owner","href":"http://localhost:3003/members"},{"rel":"plan","href":"http://localhost:3003/plans"},{"rel":"sport","href":"http://localhost:3003/sports"},{"rel":"team_preferences","href":"http://localhost:3003/teams_preferences"},{"rel":"team_public_site","href":"http://localhost:3003/team_public_sites"},{"rel":"team_results","href":"http://localhost:3003/teams_results"},{"rel":"tracked_item_statuses","href":"http://localhost:3003/tracked_item_statuses"},{"rel":"tracked_items","href":"http://localhost:3003/tracked_items"},{"rel":"root","href":"http://localhost:3003/"},{"rel":"self","href":"http://localhost:3003/teams"}],"queries":[{"rel":"search","href":"http://localhost:3003/teams/search","data":[{"name":"id","value":null},{"name":"team_id","value":null},{"name":"user_id","value":null}]}],"commands":[{"rel":"invite","href":"http://localhost:3003/teams/invite","prompt":"invite
+        team members or contacts to join TeamSnap.","data":[{"name":"team_id","value":null},{"name":"contact_id","value":null},{"name":"member_id","value":null},{"name":"introduction","value":null},{"name":"notify_as_member_id","value":null}]}]}}'
+    http_version: 
+  recorded_at: Tue, 11 Nov 2014 20:08:20 GMT
+- request:
+    method: post
+    uri: http://localhost:3003/teams
+    body:
+      encoding: UTF-8
+      string: '{"template":{"data":[{"name":"name","value":"Teamsters"},{"name":"location_country","value":"United
+        States"},{"name":"location_postal_code","value":"80951"},{"name":"time_zone","value":"America/Denver"},{"name":"sport_id","value":1}]}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: 'Created '
+    headers:
+      Content-Type:
+      - application/vnd.collection+json
+      Location:
+      - http://localhost:3003/teams/search?id=5
+      Content-Length:
+      - '6284'
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4991'
+      X-Ratelimit-Reset:
+      - '1415740100'
+      Etag:
+      - '"7685a9d4f241478253b29a4775bd305c"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - a9ae86e1-7d53-4cc5-a776-9bdefda9f871
+      X-Runtime:
+      - '0.090504'
+      Server:
+      - WEBrick/1.3.1 (Ruby/2.1.1/2014-02-24)
+      Date:
+      - Tue, 11 Nov 2014 20:53:04 GMT
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"collection":{"version":"3.1.1","href":"http://localhost:3003/teams","template":{"data":[{"name":"name","value":null},{"name":"location_country","value":null},{"name":"location_postal_code","value":null},{"name":"time_zone","value":null},{"name":"sport_id","value":null},{"name":"division_name","value":null},{"name":"season_name","value":null},{"name":"league_name","value":null},{"name":"league_url","value":null}]},"links":[{"rel":"active_season_team","href":"http://localhost:3003/teams"},{"rel":"assignments","href":"http://localhost:3003/assignments"},{"rel":"availabilities","href":"http://localhost:3003/availabilities"},{"rel":"contact_email_addresses","href":"http://localhost:3003/contact_email_addresses"},{"rel":"contact_phone_numbers","href":"http://localhost:3003/contact_phone_numbers"},{"rel":"contacts","href":"http://localhost:3003/contacts"},{"rel":"custom_data","href":"http://localhost:3003/custom_data"},{"rel":"custom_fields","href":"http://localhost:3003/custom_fields"},{"rel":"events","href":"http://localhost:3003/events"},{"rel":"locations","href":"http://localhost:3003/locations"},{"rel":"managers","href":"http://localhost:3003/members"},{"rel":"member_email_addresses","href":"http://localhost:3003/member_email_addresses"},{"rel":"member_files","href":"http://localhost:3003/member_files"},{"rel":"member_links","href":"http://localhost:3003/member_links"},{"rel":"member_phone_numbers","href":"http://localhost:3003/member_phone_numbers"},{"rel":"members","href":"http://localhost:3003/members"},{"rel":"members_preferences","href":"http://localhost:3003/members_preferences"},{"rel":"opponents","href":"http://localhost:3003/opponents"},{"rel":"owner","href":"http://localhost:3003/members"},{"rel":"plan","href":"http://localhost:3003/plans"},{"rel":"sport","href":"http://localhost:3003/sports"},{"rel":"team_preferences","href":"http://localhost:3003/teams_preferences"},{"rel":"team_public_site","href":"http://localhost:3003/team_public_sites"},{"rel":"team_results","href":"http://localhost:3003/teams_results"},{"rel":"tracked_item_statuses","href":"http://localhost:3003/tracked_item_statuses"},{"rel":"tracked_items","href":"http://localhost:3003/tracked_items"},{"rel":"root","href":"http://localhost:3003/"},{"rel":"self","href":"http://localhost:3003/teams"}],"queries":[{"rel":"search","href":"http://localhost:3003/teams/search","data":[{"name":"id","value":null},{"name":"team_id","value":null},{"name":"user_id","value":null}]}],"commands":[{"rel":"invite","href":"http://localhost:3003/teams/invite","prompt":"invite
+        team members or contacts to join TeamSnap.","data":[{"name":"team_id","value":null},{"name":"contact_id","value":null},{"name":"member_id","value":null},{"name":"introduction","value":null},{"name":"notify_as_member_id","value":null}]}],"items":[{"href":"http://localhost:3003/teams/5","data":[{"name":"id","value":5},{"name":"type","value":"team"},{"name":"name","value":"Teamsters"},{"name":"time_zone_offset","value":"-07:00"},{"name":"time_zone_iana_name","value":"America/Denver"},{"name":"time_zone_description","value":"Mountain
+        Time (US & Canada)"},{"name":"updated_at","value":"2014-11-11T20:53:04Z","type":"DateTime"},{"name":"created_at","value":"2014-11-11T20:53:04Z","type":"DateTime"},{"name":"league_name","value":null},{"name":"league_url","value":null},{"name":"division_name","value":null},{"name":"season_name","value":null},{"name":"location_country","value":"United
+        States"},{"name":"location_postal_code","value":"80951"},{"name":"is_archived_season","value":false},{"name":"sport_id","value":1},{"name":"plan_id","value":14}],"links":[{"rel":"assignments","href":"http://localhost:3003/assignments/search?team_id=5"},{"rel":"availabilities","href":"http://localhost:3003/availabilities/search?team_id=5"},{"rel":"calendar_http","href":"http://86ed2e8eefaaee16c4b7-16391cffaf9272bff70e93998d553c16.r2.cf1.rackcdn.com/team_schedule/.ics"},{"rel":"calendar_http_games_only","href":"http://86ed2e8eefaaee16c4b7-16391cffaf9272bff70e93998d553c16.r2.cf1.rackcdn.com/team_schedule/filter/games/.ics"},{"rel":"calendar_webcal","href":"webcal://86ed2e8eefaaee16c4b7-16391cffaf9272bff70e93998d553c16.r2.cf1.rackcdn.com/team_schedule/.ics"},{"rel":"calendar_webcal_games_only","href":"webcal://86ed2e8eefaaee16c4b7-16391cffaf9272bff70e93998d553c16.r2.cf1.rackcdn.com/team_schedule/filter/games/.ics"},{"rel":"contact_email_addresses","href":"http://localhost:3003/contact_email_addresses/search?team_id=5"},{"rel":"contact_phone_numbers","href":"http://localhost:3003/contact_phone_numbers/search?team_id=5"},{"rel":"contacts","href":"http://localhost:3003/contacts/search?team_id=5"},{"rel":"custom_data","href":"http://localhost:3003/custom_data/search?team_id=5"},{"rel":"custom_fields","href":"http://localhost:3003/custom_fields/search?team_id=5"},{"rel":"events","href":"http://localhost:3003/events/search?team_id=5"},{"rel":"locations","href":"http://localhost:3003/locations/search?team_id=5"},{"rel":"managers","href":"http://localhost:3003/members/managers?team_id=5"},{"rel":"member_email_addresses","href":"http://localhost:3003/member_email_addresses/search?team_id=5"},{"rel":"member_files","href":"http://localhost:3003/member_files/search?team_id=5"},{"rel":"member_links","href":"http://localhost:3003/member_links/search?team_id=5"},{"rel":"member_phone_numbers","href":"http://localhost:3003/member_phone_numbers/search?team_id=5"},{"rel":"members","href":"http://localhost:3003/members/search?team_id=5"},{"rel":"members_preferences","href":"http://localhost:3003/members_preferences/search?team_id=5"},{"rel":"opponents","href":"http://localhost:3003/opponents/search?team_id=5"},{"rel":"owner","href":"http://localhost:3003/owner_members?team_id=5"},{"rel":"plan","href":"http://localhost:3003/plans/14"},{"rel":"sport","href":"http://localhost:3003/sports/1"},{"rel":"team_preferences","href":"http://localhost:3003/teams_preferences/5"},{"rel":"team_public_site","href":"http://localhost:3003/team_public_sites/5"},{"rel":"team_results","href":"http://localhost:3003/teams_results/5"},{"rel":"tracked_item_statuses","href":"http://localhost:3003/tracked_item_statuses/search?team_id=5"},{"rel":"tracked_items","href":"http://localhost:3003/tracked_items/search?team_id=5"}]}]}}'
+    http_version: 
+  recorded_at: Tue, 11 Nov 2014 20:53:04 GMT
+- request:
+    method: post
+    uri: http://localhost:3003/teams
+    body:
+      encoding: UTF-8
+      string: '{"template":{"data":[{"name":"name","value":"Teamsters"}]}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: 'Bad Request '
+    headers:
+      Content-Type:
+      - application/vnd.collection+json
+      Content-Length:
+      - '135'
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4990'
+      X-Ratelimit-Reset:
+      - '1415740100'
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 206bb383-7b6b-40d7-9cb4-b0c5b4f825aa
+      X-Runtime:
+      - '0.024213'
+      Server:
+      - WEBrick/1.3.1 (Ruby/2.1.1/2014-02-24)
+      Date:
+      - Tue, 11 Nov 2014 20:55:14 GMT
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"collection":{"error":{"message":"sport_id can''t be blank; location_country
+        can''t be blank; You must enter a valid IANA time zone."}}}'
+    http_version: 
+  recorded_at: Tue, 11 Nov 2014 20:55:14 GMT
+recorded_with: VCR 2.9.3

data/spec/item_spec.rb

@@ -1,5 +1,115 @@
 require "spec_helper"
 
 describe TeamsnapRb::Item do
-  pending
-end
+  use_vcr_cassette "team", :allow_playback_repeats => true
+  let(:team_collection) { TeamsnapRb::Collection.new("http://localhost:3003/teams/1", {}, TeamsnapRb::Config.new) }
+  let(:team_item) { team_collection[0] }
+
+  it "represents a single item and therefore does not include Enumerable" do
+    expect(TeamsnapRb::Item).to_not include(Enumerable)
+  end
+
+  context "PATCH teams/1", :vcr do
+    describe "#save" do
+      it "successfully saves the item and returns it's collection" do
+        expect(team_item.with(:name => "Danger Rangers").save).to be_a(TeamsnapRb::Collection)
+      end
+
+      it "includes the item in the returned collection" do
+        expect(team_item.with(:name => "Danger Rangers").save.first.href).to eq(team_item.href)
+      end
+
+      it "includes the updated item's attributes in the returned collection" do
+        expect(team_item.with(:name => "Danger Rangers").save.first.name).to eq("Danger Rangers")
+      end
+    end
+  end
+
+  context "DELETE teams/1", :vcr do
+    describe "#delete" do
+      it "successfully deletes the item and returns true" do
+        expect(team_item.delete).to eq(true)
+      end
+    end
+  end
+
+  context "GET teams/1", :vcr do
+    describe "#href" do
+      it "returns 'teams/1' where 1 is the id of the item" do
+        expect(team_item.href).to eq("http://localhost:3003/teams/1")
+      end
+    end
+
+    describe "accessing item properties" do
+      it "provides direct access to item properties" do
+        expect(team_item.name).to eq("Test Mania")
+      end
+    end
+
+    describe "#data" do
+      let(:data) { team_item.data }
+
+      it "returns a Conglomerate::Array of attributes from the collection response's data section" do
+        expect(data).to be_a(Conglomerate::Array)
+      end
+
+      it "returns a Conglomerate::Datum for each data item in the Conglomerate::Array" do
+        expect(data.first).to be_a(Conglomerate::Datum)
+      end
+
+      it "returns the correct value for a given datum" do
+        expect(data.first.name).to eq("id")
+        expect(data.first.value).to eq(1)
+      end
+    end
+
+    describe "#template" do
+      it "returns a TeamsnapRb::Template" do
+        expect(team_item.template).to be_a(TeamsnapRb::Template)
+      end
+
+      it "caches the template on the Item class" do
+        team_item.template
+        expect(TeamsnapRb::Item.templates.keys).to include("team")
+      end
+    end
+
+    describe "#this" do
+      it "returns the collection this item belongs to" do
+        expect(team_item.this).to be_a(TeamsnapRb::Collection)
+      end
+
+      it "returns a collection with an href that is the generalized form of the specific item href" do
+        expect(team_item.href).to include(team_item.this.href)
+      end
+    end
+
+    describe "#links" do
+      it "returns a LinksProxy" do
+        expect(team_item.links).to be_a(TeamsnapRb::LinksProxy)
+      end
+
+      it "consists of an array of Links" do
+        expect(team_item.links.first).to be_a(TeamsnapRb::Link)
+      end
+
+      it "can be accessed like an array" do
+        expect(team_item.links.first.href).to eq("http://localhost:3003/assignments/search?team_id=1")
+      end
+    end
+
+    describe "#with(attrs)" do
+      it "returns a new TeamsnapRb::Item" do
+        expect(team_item.with(name: "Goofballs")).to be_a(TeamsnapRb::Item)
+      end
+
+      it "has the updated attributes on the new TeamsnapRb::Item" do
+        expect(team_item.with(name: "Goofballs").name).to eq("Goofballs")
+      end
+
+      it "creates a new object rather than mutating the existing object" do
+        expect{team_item.with(name: "Goofballs")}.to_not change(team_item, :name)
+      end
+    end
+  end
+end

data/spec/link_spec.rb

@@ -1,5 +1,43 @@
 require "spec_helper"
 
 describe TeamsnapRb::Link do
-  pending 
-end
+  let(:config) { TeamsnapRb::Config.new }
+  let(:collection) { double(
+    TeamsnapRb::Collection, :href => "http://localhost:3003/")
+  }
+  let(:conglomerate_link) { double(
+    Conglomerate::Link, :rel => "team",
+    :href => "http://localhost:3003/", :follow => collection
+  ) }
+  let(:link) { TeamsnapRb::Link.new(conglomerate_link, config) }
+
+  describe "#new" do
+    it "accepts a Conglomerate item as a link" do
+      expect{link}.to_not raise_exception
+    end
+  end
+
+  describe "#follow" do
+    use_vcr_cassette "root"
+
+    it "returns the Collection represented by that href" do
+      expect(link.follow).to be_a(TeamsnapRb::Collection)
+    end
+
+    it "returns the Collection represented by that href" do
+      expect(link.follow.href).to eq("http://localhost:3003/")
+    end
+  end
+
+  describe "#rel" do
+    it "returns the rel of the link passed in" do
+      expect(link.rel).to eq("team")
+    end
+  end
+
+  describe "#href" do
+    it "returns the href of the link passed in" do
+      expect(link.href).to eq("http://localhost:3003/")
+    end
+  end
+end

data/spec/links_proxy_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe TeamsnapRb::LinksProxy do
+  use_vcr_cassette "root"
+  let(:links_proxy) { TeamsnapRb::Collection.new(
+    "http://localhost:3003", {}, TeamsnapRb::Config.new
+  ).links }
+
+  describe "#new" do
+    it "accepts an array of links from a collection+json response and a config" do
+      expect(links_proxy).to be_a(TeamsnapRb::LinksProxy)
+    end
+  end
+
+  describe "#rels" do
+    it "returns an array of the link names represented as symbols" do
+      expect(links_proxy.rels).to include(:teams, :members)
+    end
+  end
+
+  describe "sending a link name to the LinksProxy" do
+    use_vcr_cassette "teams"
+
+    it "follows the link if a matching link rel is found" do
+      expect(links_proxy.teams).to be_a(TeamsnapRb::Collection)
+    end
+
+    it "returns a TeamsnapRb::Collection of the matching rel as the link" do
+      expect(links_proxy.teams.href).to include("/teams")
+    end
+  end
+end

data/spec/queries_proxy_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe TeamsnapRb::QueriesProxy do
+  use_vcr_cassette "root"
+
+  let(:queries_proxy) { TeamsnapRb::Collection.new(
+    "http://localhost:3003", {}, TeamsnapRb::Config.new
+  ).queries }
+
+  describe "#new" do
+    it "accepts an array of queries from a collection+json response and a config" do
+      expect(queries_proxy).to be_a(TeamsnapRb::QueriesProxy)
+    end
+  end
+
+  describe "#rels" do
+    it "returns an array of the link names represented as symbols" do
+      expect(queries_proxy.rels).to include(:bulk_load)
+    end
+  end
+
+  describe "sending a link name to the QueriesProxy" do
+    it "raises a MissingQueryParameter exception if params are missing from the query" do
+      expect{queries_proxy.bulk_load}.to raise_exception(TeamsnapRb::Query::MissingQueryParameter)
+    end
+
+    it "returns a TeamsnapRB::Collection when the query executes successfully" do
+      expect(queries_proxy.bulk_load(:team_id => 1)).to be_a(TeamsnapRb::Collection)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,19 @@
+require 'coveralls'
+Coveralls.wear!
+
 require "teamsnap_rb"
 require "pry"
+require "webmock/rspec"
+require "vcr"
 
 RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
   config.color = true
   config.order = "random"
 end
+
+VCR.configure do |c|
+  c.configure_rspec_metadata!
+  c.cassette_library_dir = "spec/fixtures/cassettes"
+  c.hook_into :webmock
+end

data/spec/template_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe TeamsnapRb::Template do
+  use_vcr_cassette "teams", :match_requests_on => [:host, :path, :body]
+
+  let(:template) { TeamsnapRb::Collection.new(
+    "http://localhost:3003/teams", {}, TeamsnapRb::Config.new
+  ).template }
+
+  describe "#new" do
+    it "returns a template object from Collection#template" do
+      expect(template).to be_a(TeamsnapRb::Template)
+    end
+  end
+
+  describe "#build" do
+    it "returns an empty hash when no attributes are passed in" do
+      expect(template.build).to eq("template" => {})
+    end
+
+    it "returns a properly serialized template hash when attrs are passed in" do
+      expect(template.build("name" => "Teamsters")).to eq(
+        {
+          "template"=> {
+            "data"=>[{
+              "name"=>"name", "value"=>"Teamsters"
+            }]
+          }
+        }
+      )
+    end
+  end
+
+  describe "#data" do
+    it "returns a Conglomerate::Array of data that can be passed into the template" do
+      expect(template.data).to be_a(Conglomerate::Array)
+    end
+  end
+
+  describe "POST /teams via Template#push" do
+    it "returns a bad response (400) when the template fails to post" do
+      expect(template.push("name" => "Teamsters").status).to eq(400)
+    end
+
+    it "returns a success (200) when the template posts with all required data" do
+      expect(
+        template.push(
+          "name" => "Teamsters",
+          "sport_id" => 1,
+          "location_country" => "United States",
+          "location_postal_code" => "80951",
+          "time_zone" => "America/Denver"
+        ).status
+      ).to eq(201)
+    end
+  end
+end