remind101 0.0.1 → 0.1.0

data/README.md

@@ -18,30 +18,30 @@ gem 'remind101'
 remind101 = Remind101::Client.new(auth_token: 'token')
 ```
 
-### classes
+### groups
 
-Returns an `Array` of `Hashie::Mash`'s for all the classes for the currently
+Returns an `Array` of `Hashie::Mash`'s for all the groups for the currently
 logged in user.
 
 ```ruby
-remind101.classes
+remind101.groups
 # => [{ ... }]
 ```
 
-### create\_class
+### create\_group
 
-Creates the class and returns a `Hashie::Mash`.
+Creates the group and returns a `Hashie::Mash`.
 
 ```ruby
-remind101.create_class name: 'Math 101'
+remind101.create_group class_name: 'Math 101'
 ```
 
-### destroy\_class
+### destroy\_group
 
-Destroys the class with the given `id`.
+Destroys the group with the given `id`.
 
 ```ruby
-remind101.destroy_class 1234
+remind101.destroy_group 1234
 ```
 
 ### messages
@@ -56,7 +56,7 @@ remind101.messages
 
 ### send\_message
 
-Send a new message to all subscribers of the given class. Returns a
+Send a new message to all subscribers of the given group. Returns a
 `Hashie::Mash` for the created message.
 
 ```ruby
@@ -76,13 +76,29 @@ remind101.cancel_message 4321
 ### subscribers
 
 Returns an `Array` of `Hashie::Mash`'s for all the subscribers of the given
-class.
+group.
 
 ```ruby
 remind101.subscribers 1234
 # => [{ ... }]
 ```
 
+### Validation Errors
+
+When a validation error is returned (HTTP 422), a
+`Remind101::Error::ValidationError` with be raised. The `#error` method on this
+object will be a key/val hash of the errors.
+
+```ruby
+begin
+  remind101.create_group! class_name: '1'
+rescue Remind101::Error::ValidationError => e
+  e.error.each do |attribute, errors|
+    p "#{attribute}: #{errors}"
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/remind101/client/groups.rb

@@ -0,0 +1,41 @@
+module Remind101::Client::Groups
+  extend Remind101::Client::Rescuable
+
+  # Public: Returns all groups for the current user.
+  #
+  # Examples
+  #
+  #   remind101.groups
+  #   # => [{ ... }]
+  #
+  # Returns an Array of all groups.
+  def groups
+    api_get('/groups').body
+  end
+
+  # Public: Creates a new group.
+  #
+  # Examples
+  #
+  #   remind101.create_group! name: 'Math 101'
+  #   # => { :id => 4321, :name => "Math 101", ... }
+  #
+  # Returns the created group.
+  def create_group!(hash)
+    api_post('/groups', group: hash).body
+  end
+  def_rescued :create_group, :create_group!
+
+  # Public: Destroys an existing group.
+  #
+  # Examples
+  #
+  #   remind101.destroy_group! 4321
+  #   # => { :id => 4321, :name => "Math 101", ... }
+  #
+  # Returns the destroyed group.
+  def destroy_group!(group_id)
+    api_delete("/groups/#{group_id}").body
+  end
+  def_rescued :destroy_group, :destroy_group!
+end

data/lib/remind101/client/messages.rb

@@ -1,10 +1,28 @@
 module Remind101::Client::Messages
   extend Remind101::Client::Rescuable
 
+  # Public: Returns all messages for the current user.
+  #
+  # Examples
+  #
+  #   remind101.messages
+  #   # => [{ ... }]
+  #
+  # Returns an Array of all messages.
   def messages
     api_get('/messages').body
   end
 
+  # Public: Creates a new message.
+  #
+  # Also aliased as `#send_message!`.
+  #
+  # Examples
+  #
+  #   remind101.create_message! body: 'Hello World!', group_ids: [1234]
+  #   # => { :id => 4321, :body => "Hello World!", :group_ids => [1234], ... }
+  #
+  # Returns the created message.
   def create_message!(hash)
     api_post('/messages', message: hash).body
   end
@@ -12,6 +30,16 @@ module Remind101::Client::Messages
   alias_method :send_message!,  :create_message!
   alias_method :send_message,   :create_message
 
+  # Public: Destroy an existing message.
+  #
+  # Also aliased as `cancel_message!`.
+  #
+  # Examples
+  #
+  #   remind101.destroy_message! 4321
+  #   # => { :id => 4321, :body => "Hello World!", :group_ids => [1234], ... }
+  #
+  # Returns the destroyed message.
   def destroy_message!(message_id)
     api_delete("/messages/#{message_id}").body
   end

data/lib/remind101/client/subscribers.rb

@@ -1,5 +1,39 @@
 module Remind101::Client::Subscribers
-  def subscribers(class_id)
-    api_get("/classes/#{class_id}/subscribers").body
+  extend Remind101::Client::Rescuable
+
+  # Public: Returns all subscribers for the given group.
+  #
+  # Examples
+  #
+  #   remind101.subscribers 1234
+  #   #=> [{ ... }]
+  #
+  # Returns an Array of all subscribers.
+  def subscribers(group_id)
+    api_get("/groups/#{group_id}/subscribers").body
   end
+
+  # Public: Removes a subscriber from the group.
+  #
+  # Examples
+  #
+  #   remind101.remove_subscriber! 1234, 4321
+  #
+  # Returns the removed subscriber.
+  def remove_subscriber!(group_id, subscriber_id)
+    api_delete("/groups/#{group_id}/subscribers/#{subscriber_id}").body
+  end
+  def_rescued :remove_subscriber, :remove_subscriber!
+
+  # Public: Removes all subscribers from the group.
+  #
+  # Examples
+  #
+  #   remind101.remove_subscribers!
+  #
+  # Returns true if all subscribers were removed.
+  def remove_subscribers!(group_id)
+    api_delete("/groups/#{group_id}/subscribers").body
+  end
+  def_rescued :remove_subscribers, :remove_subscribers!
 end

data/lib/remind101/client.rb

@@ -2,12 +2,12 @@ module Remind101
   class Client
     require 'remind101/client/rescuable'
     require 'remind101/client/connection'
-    require 'remind101/client/classes'
+    require 'remind101/client/groups'
     require 'remind101/client/messages'
     require 'remind101/client/subscribers'
 
     include Connection
-    include Classes
+    include Groups
     include Messages
     include Subscribers
 

data/lib/remind101/error.rb

@@ -5,7 +5,18 @@ module Remind101
       const_set(const, Faraday::Error.const_get(const))
     end
 
-    BadInput        = Class.new(ClientError)
-    ValidationError = Class.new(ClientError)
+    module ErrorsBody
+      def error
+        response.body.error
+      end
+    end
+
+    class BadInput < ClientError
+      include ErrorsBody
+    end
+
+    class ValidationError < ClientError
+      include ErrorsBody
+    end
   end
 end

data/lib/remind101/version.rb

@@ -1,3 +1,3 @@
 module Remind101
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/remind101/client_spec.rb

@@ -1,31 +1,32 @@
 require 'spec_helper'
 
 describe Remind101::Client do
-  let(:class_id  ) { 1234 }
-  let(:message_id) { 4321 }
-  let(:client    ) { described_class.new }
+  let(:group_id     ) { 1234 }
+  let(:message_id   ) { 4321 }
+  let(:subscriber_id) { 789 }
+  let(:client       ) { described_class.new }
 
-  describe '#classes' do
-    before { stub_request(:get, 'https://api.remind101.com/v2/classes') }
+  describe '#groups' do
+    before { stub_request(:get, 'https://api.remind101.com/v2/groups') }
 
-    it 'gets the classes' do
-      client.classes
+    it 'gets the groups' do
+      client.groups
     end
   end
 
-  describe '#create_class' do
-    before { stub_request(:post, 'https://api.remind101.com/v2/classes') }
+  describe '#create_group!' do
+    before { stub_request(:post, 'https://api.remind101.com/v2/groups') }
 
-    it 'creates the class' do
-      client.create_class name: 'Math 101'
+    it 'creates the group' do
+      client.create_group! name: 'Math 101'
     end
   end
 
-  describe '#destroy_class' do
-    before { stub_request(:delete, "https://api.remind101.com/v2/classes/#{class_id}") }
+  describe '#destroy_group!' do
+    before { stub_request(:delete, "https://api.remind101.com/v2/groups/#{group_id}") }
 
-    it 'destroys the class' do
-      client.destroy_class class_id
+    it 'destroys the group' do
+      client.destroy_group! group_id
     end
   end
 
@@ -37,27 +38,43 @@ describe Remind101::Client do
     end
   end
 
-  describe '#create_message' do
+  describe '#create_message!' do
     before { stub_request(:post, 'https://api.remind101.com/v2/messages') }
 
     it 'creates the message' do
-      client.create_message body: "There's a test tomorrow!", group_ids: [class_id]
+      client.create_message! body: "There's a test tomorrow!", group_ids: [group_id]
     end
   end
 
-  describe '#destroy_message' do
+  describe '#destroy_message!' do
     before { stub_request(:delete, "https://api.remind101.com/v2/messages/#{message_id}") }
 
     it 'destroys the message' do
-      client.destroy_message message_id
+      client.destroy_message! message_id
     end
   end
 
   describe '#subscribers' do
-    before { stub_request(:get, "https://api.remind101.com/v2/classes/#{class_id}/subscribers") }
+    before { stub_request(:get, "https://api.remind101.com/v2/groups/#{group_id}/subscribers") }
 
     it 'gets the subscribers' do
-      client.subscribers(class_id)
+      client.subscribers(group_id)
+    end
+  end
+
+  describe '#remove_subscriber!' do
+    before { stub_request(:delete, "https://api.remind101.com/v2/groups/#{group_id}/subscribers/#{subscriber_id}") }
+    
+    it 'removes the subscriber' do
+      client.remove_subscriber!(group_id, subscriber_id)
+    end
+  end
+
+  describe '#remove_subscribers!' do
+    before { stub_request(:delete, "https://api.remind101.com/v2/groups/#{group_id}/subscribers") }
+    
+    it 'removes the subscriber' do
+      client.remove_subscribers!(group_id)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remind101
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,8 +162,8 @@ files:
 - Rakefile
 - lib/remind101.rb
 - lib/remind101/client.rb
-- lib/remind101/client/classes.rb
 - lib/remind101/client/connection.rb
+- lib/remind101/client/groups.rb
 - lib/remind101/client/messages.rb
 - lib/remind101/client/rescuable.rb
 - lib/remind101/client/subscribers.rb
@@ -190,7 +190,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -779571737398577944
+      hash: -1908290670246690912
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -779571737398577944
+      hash: -1908290670246690912
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/lib/remind101/client/classes.rb

@@ -1,17 +0,0 @@
-module Remind101::Client::Classes
-  extend Remind101::Client::Rescuable
-
-  def classes
-    api_get('/classes').body
-  end
-
-  def create_class!(hash)
-    api_post('/classes', group: hash).body
-  end
-  def_rescued :create_class, :create_class!
-
-  def destroy_class!(class_id)
-    api_delete("/classes/#{class_id}").body
-  end
-  def_rescued :destroy_class, :destroy_class!
-end