teamsnap_rb 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 271d6792d1276598cd7193f19239a68722e98550
-  data.tar.gz: 66ed86b86c205ac1a886869920c0f3fcdec5101d
+  metadata.gz: 29904a91fc42a2faba569cde41db6452757595c5
+  data.tar.gz: 2a8c0c3fd6ce5ae221583350285070911f59aa75
 SHA512:
-  metadata.gz: d1bf7ebf7571461c5117afb48c3252e1f047f6c6929fa6918647ce797b1831c2224e8f8ee4ec9fcac4d0552053027c29f24edb4252619b12baddd678da93dd03
-  data.tar.gz: 7ea0a6955a7d44ff3cdb0de0d14e88f92dc4cdcf8eda455fdeec12c5bc7c921854b962f73e27fa38e646e372f45620ee44d06d56b49bdaec6fd5229501287353
+  metadata.gz: 8963bb77684586da59b7a8d5727bcca2ce5c70d0d92a2804085918a6f8b0663d13d60a172c9eb4451e36afa42f30b57452a3b6bd6cffc008640ecd8261093ba7
+  data.tar.gz: 45df529d9018566208d00f09cc2ff948db2d03b154530b2f8b82c90e14d58fed7a5c809918bb03686a8da9086309837f06f8911125e20de339f53300eb0aae97

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in teamsnap_rb.gemspec
+gem "coveralls", :require => false
+gem "pry", :require => false
+
 gemspec

data/Gemfile.lock

@@ -1,25 +1,41 @@
 PATH
   remote: .
   specs:
-    teamsnap_rb (0.0.3)
+    teamsnap_rb (0.0.5)
       conglomerate (>= 0.15.0)
       faraday (~> 0.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.3.6)
     coderay (1.1.0)
-    conglomerate (0.15.0)
+    conglomerate (0.16.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
     method_source (0.8.2)
+    mime-types (2.4.3)
+    multi_json (1.10.1)
     multipart-post (2.0.0)
+    netrc (0.8.0)
     pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
     rake (10.1.1)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
       rspec-expectations (~> 3.0.0)
@@ -32,14 +48,31 @@ GEM
     rspec-mocks (3.0.3)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.3)
+    safe_yaml (1.0.4)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.4.7)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.3)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.5)
+  coveralls
   pry
   rake
   rspec (>= 3.0.0)
   teamsnap_rb!
+  vcr
+  webmock

data/README.md

@@ -1,3 +1,10 @@
+# TeamSnapRb
+
+[ ![Codeship Status for teamsnap/teamsnap_rb](https://codeship.com/projects/535cff20-4bf3-0132-5b73-3612ac61d213/status)](https://codeship.com/projects/46910)
+
+[![Code Climate](https://codeclimate.com/github/teamsnap/teamsnap_rb/badges/gpa.svg)](https://codeclimate.com/github/teamsnap/teamsnap_rb)
+[![Coverage Status](https://coveralls.io/repos/teamsnap/teamsnap_rb/badge.png)](https://coveralls.io/r/teamsnap/teamsnap_rb)
+
 # EARLY ACCESS
 
 Please be aware there may be bugs, gremlins, and horrible issues; and you could be eaten by a grue. We are not responsible for any loss of life or limb (especially if you are eaten by a grue).
@@ -26,8 +33,39 @@ Needs to be updated; coming soon.
 
 ## Contributing
 
+### Git Workflow
+
 1. Fork it ( http://github.com/teamsnap/teamsnap_rb/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`)
 5. Create new Pull Request
+
+### Testing teamsnap_rb
+
+`./bin/rspec` will run the test suite.
+
+### teamsnap_rb in IRB
+
+```ruby
+$ irb
+> require 'teamsnap_rb'
+=> true
+> client_config = TeamsnapRb::Config.new(
+>   client_id: "your_client_id_here",
+>   client_secret: "ssshhhhhh!"
+> )
+> client = TeamsnapRb::Client.new("http://apiv3.teamsnap.com/", config: client_config)
+=> # client object
+> team = client.teams.search(:id => "your_team_id_here").first
+=> # team object
+```
+
+In order to work on teamsnap_rb most effectively and efficiently, it'll he helpful
+to have a TeamSnap account and teams so you can work with that data. You can
+create a TeamSnap account [here](https://go.teamsnap.com) and you can then
+authorize a client application using our [Cogsworth
+service](https://auth.teamsnap.com).
+
+With a client ID and secret in hand, you can begin interacting with the gem
+using real data.

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require 'coveralls/rake/task'
+
+Coveralls::RakeTask.new

data/lib/teamsnap_rb.rb

@@ -3,18 +3,20 @@ require "json"
 require "faraday"
 require "securerandom"
 
-require "teamsnap_rb/version"
-require "teamsnap_rb/exceptions"
-require "teamsnap_rb/config"
-require "teamsnap_rb/request_builder"
-require "teamsnap_rb/link"
-require "teamsnap_rb/links_proxy"
-require "teamsnap_rb/queries_proxy"
-require "teamsnap_rb/item"
-require "teamsnap_rb/template"
-require "teamsnap_rb/models/event"
-require "teamsnap_rb/collection"
-require "teamsnap_rb/client"
+require_relative "teamsnap_rb/version"
+require_relative "teamsnap_rb/exceptions"
+require_relative "teamsnap_rb/config"
+require_relative "teamsnap_rb/request_builder"
+require_relative "teamsnap_rb/link"
+require_relative "teamsnap_rb/links_proxy"
+require_relative "teamsnap_rb/queries_proxy"
+require_relative "teamsnap_rb/item"
+require_relative "teamsnap_rb/template"
+require_relative "teamsnap_rb/command"
+require_relative "teamsnap_rb/commands"
+require_relative "teamsnap_rb/models/event"
+require_relative "teamsnap_rb/collection"
+require_relative "teamsnap_rb/client"
 
 module TeamsnapRb
 end

data/lib/teamsnap_rb/collection.rb

@@ -71,14 +71,6 @@ module TeamsnapRb
       links.respond_to?(method) || queries.respond_to?(method)
     end
 
-    def collection
-      @collection ||= Collection.new(href, {}, config)
-    end
-
-    def this
-      @this ||= Collection.new(this_href, {}, config)
-    end
-
     def links
       @links ||= LinksProxy.new(collection_json.links, config)
     end
@@ -88,7 +80,11 @@ module TeamsnapRb
     end
 
     def template
-      @template ||= TemplateProxy.new(collection_json.template, config, href)
+      @template ||= Template.new(collection_json.template, config, href)
+    end
+
+    def commands
+      @commands ||= CommandsProxy.new(collection_json.commands, config)
     end
 
     def error

data/lib/teamsnap_rb/command.rb

@@ -0,0 +1,39 @@
+module TeamsnapRb
+  class Command
+    def initialize(command, config)
+      self.command = command
+      self.config = config
+    end
+
+    def execute(attrs = {})
+      post(attrs.flatten.first)
+    end
+
+    def rel
+      command.rel
+    end
+
+    def href
+      command.href
+    end
+
+    def prompt
+      command.prompt
+    end
+
+    def data
+      command.data.map(&:name)
+    end
+
+    private
+
+    def post(attrs = {})
+      RequestBuilder.new(config, href).connection.post do |conn|
+        conn.body = attrs.to_json
+        conn.headers['Content-Type'] = 'application/json'
+      end
+    end
+
+    attr_accessor :command, :config
+  end
+end

data/lib/teamsnap_rb/commands.rb

@@ -0,0 +1,40 @@
+module TeamsnapRb
+  class CommandsProxy
+    include Enumerable
+
+    def initialize(commands, config)
+      self.config = config
+      self.commands = commands.inject({}) do |h, command|
+        h.tap do |hash|
+          hash[command.rel.to_sym] = Command.new(command, config)
+        end
+      end
+    end
+
+    def method_missing(method, *args)
+      if command = commands[method.to_sym]
+        command.execute(args)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method)
+      commands.include?(method.to_sym) || super
+    end
+
+    def each
+      commands.values.each do |command|
+        yield command
+      end
+    end
+
+    def rels
+      commands.keys
+    end
+
+    private
+
+    attr_accessor :commands, :config
+  end
+end

data/lib/teamsnap_rb/item.rb

@@ -10,6 +10,39 @@ module TeamsnapRb
       self.item = item
     end
 
+    def href
+      item.href
+    end
+
+    def data
+      item.data
+    end
+
+    def template
+      self.class.templates[type] ||= fetch_template
+    end
+
+    def this
+      @this ||= Collection.new(href, {}, config)
+    end
+
+    def links
+      @links ||= LinksProxy.new(item.links, config)
+    end
+
+    def commands
+      @commands ||= CommandsProxy.new(item.commands)
+    end
+
+    def delete
+      response = delete_href(href)
+      if response.status == 204
+        true
+      else
+        raise FailedToDelete
+      end
+    end
+
     def with(attrs)
       attrs = Hash[attrs.map{ |k, v| [k.to_s, v] }]
       dirtied_attrs = attrs.keys
@@ -44,20 +77,8 @@ module TeamsnapRb
       Collection.new(nil, nil, config, :request => request)
     end
 
-    def attributes
-      @attributes ||= data.inject({}) do |h, datum|
-        h.tap do |hash|
-          hash[datum.name] = datum.value
-        end
-      end
-    end
-
-    def href
-      item.href
-    end
-
     def method_missing(method, *args)
-      if datum = item.data.find { |d| d.name == method.to_s }
+      if datum = data.find { |d| d.name == method.to_s }
         unless instance_variable_get("@#{method}_datum")
           instance_variable_set("@#{method}_datum", datum.value)
         end
@@ -65,46 +86,33 @@ module TeamsnapRb
         instance_variable_get("@#{method}_datum")
       elsif links.respond_to?(method)
         links.send(method)
+      elsif commands.respond_to?(method)
+        commands.send(method, args)
       else
         super
       end
     end
 
     def respond_to?(method)
-      if item.data.find { |d| d.name == method.to_s }
+      if data.find { |d| d.name == method.to_s }
         true
-      else
+      elsif
         links.respond_to?(method)
+      elsif
+        commands.respond_to?(method)
       end
     end
 
-    def data
-      item.data
-    end
-
-    def template
-      self.class.templates[type] ||= fetch_template
-    end
+    private
 
-    def delete
-      response = delete_href(href)
-      if response.status == 204
-        true
-      else
-        raise FailedToDelete
+    def attributes
+      @attributes ||= data.inject({}) do |h, datum|
+        h.tap do |hash|
+          hash[datum.name] = datum.value
+        end
       end
     end
 
-    def this
-      @this ||= Collection.new(href, {}, config)
-    end
-
-    def links
-      @links ||= LinksProxy.new(item.links, config)
-    end
-
-    private
-
     def delete_href(href)
       RequestBuilder.new(config, href).connection.delete
     end
@@ -117,6 +125,10 @@ module TeamsnapRb
       this.template
     end
 
+    def fetch_commands
+      this.commands
+    end
+
     attr_accessor :item, :config, :dirty_attributes
   end
 

data/lib/teamsnap_rb/template.rb

@@ -1,5 +1,5 @@
 module TeamsnapRb
-  class TemplateProxy
+  class Template
     def initialize(template, config, url)
       self.config = config
       self.template = template

data/lib/teamsnap_rb/version.rb

@@ -1,3 +1,3 @@
 module TeamsnapRb
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/client_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe TeamsnapRb::Client do
+  describe "#new (GET production root/)" do
+    use_vcr_cassette "production_root"
+
+    it "raises an HttpError for unauthorized access" do
+      expect{TeamsnapRb::Client.new}.to raise_exception(TeamsnapRb::HttpError)
+    end
+  end
+
+  context "#new (GET local root/)" do
+    use_vcr_cassette "root"
+
+    it "does not raise an error when authorized" do
+      expect{TeamsnapRb::Client.new("http://localhost:3003/")}.to_not raise_exception
+    end
+
+    it "return a TeamsnapRb::Collection" do
+      expect(TeamsnapRb::Client.new("http://localhost:3003/")).to be_a(TeamsnapRb::Collection)
+    end
+  end
+
+  context "#teams (GET local teams/)" do
+    use_vcr_cassette "root"
+    let(:client) { TeamsnapRb::Client.new("http://localhost:3003") }
+
+    describe "client navigation of the api" do
+      it "responds to links in the root collection, returning the appropriate collection" do
+        expect(client.teams).to be_a(TeamsnapRb::Collection)
+      end
+
+      it "enables access to collections and items directly from the client" do
+        team = client.teams.search(:id => 1).first
+        expect(team.id).to eq(1)
+      end
+    end
+  end
+end