remind101 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in remind101.gemspec
+gemspec
+
+group :development do
+  gem 'guard-rspec', '~> 3.0'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^lib/remind101/(.+)\.rb$})                 { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/remind101/(.+)\.rb$})                 { |m| "spec/remind101/client_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric J. Holmes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Remind101
+
+[![Build Status](https://magnum.travis-ci.com/remind101/remind101.rb.png?token=Uca1q7og621AjpUDJUEC)](https://magnum.travis-ci.com/remind101/remind101.rb)
+
+A thin Ruby client for the Remind101 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remind101'
+```
+
+## Usage
+
+```ruby
+remind101 = Remind101::Client.new(auth_token: 'token')
+```
+
+### classes
+
+Returns an `Array` of `Hashie::Mash`'s for all the classes for the currently
+logged in user.
+
+```ruby
+remind101.classes
+# => [{ ... }]
+```
+
+### create\_class
+
+Creates the class and returns a `Hashie::Mash`.
+
+```ruby
+remind101.create_class name: 'Math 101'
+```
+
+### destroy\_class
+
+Destroys the class with the given `id`.
+
+```ruby
+remind101.destroy_class 1234
+```
+
+### messages
+
+Returns an `Array` of `Hashie::Mash`'s for all the messages for the currently
+logged in user.
+
+```ruby
+remind101.messages
+# => [{ ... }]
+```
+
+### send\_message
+
+Send a new message to all subscribers of the given class. Returns a
+`Hashie::Mash` for the created message.
+
+```ruby
+remind101.send_message body: 'Be ready for the test tomorrow!', group_ids: [1234]
+# => { id: 4321, body: 'Be ready for the test tomorrow!' }
+```
+
+### cancel\_message
+
+Attempts to destroy (cancel) a message.
+
+```ruby
+remind101.cancel_message 4321
+# => true
+```
+
+### subscribers
+
+Returns an `Array` of `Hashie::Mash`'s for all the subscribers of the given
+class.
+
+```ruby
+remind101.subscribers 1234
+# => [{ ... }]
+```
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/remind101/client/classes.rb

@@ -0,0 +1,17 @@
+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

data/lib/remind101/client/connection.rb

@@ -0,0 +1,59 @@
+module Remind101::Client::Connection
+
+  %w[get post put patch delete options head].each do |method|
+    define_method method do |*args, &block|
+      connection.__send__ method, *args, &block
+    end
+
+    define_method :"api_#{method}" do |path, *args, &block|
+      __send__ method, api_path(path), *args, &block
+    end
+  end
+
+  # Public: The Faraday::Builder instance used for the middleware stack. This
+  # can be used to insert a custom middleware.
+  #
+  # Examples
+  #
+  #   # Add the instrumentation middleware for Rails.
+  #   client.middleware.use FaradayMiddleware::Instrumentation
+  #
+  # Returns the Faraday::Builder for the Faraday connection.
+  def middleware
+    connection.builder
+  end
+  alias_method :builder, :middleware
+
+  private
+
+  def api_path(path)
+    "/#{configuration.version}#{path}"
+  end
+
+  # Internal: Internal faraday connection where all requests go through
+  def connection
+    @connection ||= Faraday.new(configuration.endpoint) do |builder|
+      # Raise exceptions for HTTP error status's
+      builder.use      Remind101::Middleware::RaiseError
+      # Add auth_token to query string.
+      builder.request  :oauth2, auth_token, param_name: 'auth_token'
+      # Turn the response into a Hashie::Mash.
+      builder.response :mashify
+      # Parse ISO 8601 dates.
+      builder.use      FaradayMiddleware::ParseDates
+      # Converts the request into JSON.
+      builder.request  :json
+      # Parses returned JSON response into a hash.
+      builder.response :json, content_type: /\bjson$/
+      # Follows 30x redirects.
+      builder.response :follow_redirects
+
+      builder.adapter  configuration.adapter
+    end
+  end
+
+  def configuration
+    Remind101.configuration
+  end
+
+end

data/lib/remind101/client/messages.rb

@@ -0,0 +1,21 @@
+module Remind101::Client::Messages
+  extend Remind101::Client::Rescuable
+
+  def messages
+    api_get('/messages').body
+  end
+
+  def create_message!(hash)
+    api_post('/messages', message: hash).body
+  end
+  def_rescued  :create_message, :create_message!
+  alias_method :send_message!,  :create_message!
+  alias_method :send_message,   :create_message
+
+  def destroy_message!(message_id)
+    api_delete("/messages/#{message_id}").body
+  end
+  def_rescued  :destroy_message, :destroy_message!
+  alias_method :cancel_message!, :destroy_message!
+  alias_method :cancel_message,  :destroy_message
+end

data/lib/remind101/client/rescuable.rb

@@ -0,0 +1,27 @@
+module Remind101::Client::Rescuable
+
+  # Internal: Defines a version of the method that will be rescued from
+  # ClientError's
+  #
+  # Example
+  #
+  #   def my_method!
+  #     raise Remind101::Error::ClientError
+  #   end
+  #   def_rescued :my_method, :my_method!
+  #
+  #   my_method
+  #   # => false
+  #
+  # Returns nothing.
+  def def_rescued(new, original)
+    define_method new do |*args, &block|
+      begin
+        __send__ original, *args, &block
+      rescue Remind101::Error::ClientError
+        false
+      end
+    end
+  end
+
+end

data/lib/remind101/client/subscribers.rb

@@ -0,0 +1,5 @@
+module Remind101::Client::Subscribers
+  def subscribers(class_id)
+    api_get("/classes/#{class_id}/subscribers").body
+  end
+end

data/lib/remind101/client.rb

@@ -0,0 +1,27 @@
+module Remind101
+  class Client
+    require 'remind101/client/rescuable'
+    require 'remind101/client/connection'
+    require 'remind101/client/classes'
+    require 'remind101/client/messages'
+    require 'remind101/client/subscribers'
+
+    include Connection
+    include Classes
+    include Messages
+    include Subscribers
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+      yield middleware if block_given?
+    end
+
+    private
+
+    def auth_token
+      options[:auth_token]
+    end
+  end
+end

data/lib/remind101/configuration.rb

@@ -0,0 +1,19 @@
+module Remind101
+  class Configuration
+    attr_accessor :endpoint
+    attr_accessor :adapter
+    attr_accessor :version
+
+    def endpoint
+      @endpoint ||= 'https://api.remind101.com'
+    end
+
+    def adapter
+      @adapter ||= Faraday.default_adapter
+    end
+
+    def version
+      @version ||= 'v2'
+    end
+  end
+end

data/lib/remind101/error.rb

@@ -0,0 +1,11 @@
+module Remind101
+  module Error
+    # White label faraday's errors.
+    Faraday::Error.constants.each do |const|
+      const_set(const, Faraday::Error.const_get(const))
+    end
+
+    BadInput        = Class.new(ClientError)
+    ValidationError = Class.new(ClientError)
+  end
+end

data/lib/remind101/middleware/raise_error.rb

@@ -0,0 +1,27 @@
+module Remind101
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware
+      ClientErrorStatuses = 401...600
+
+      def on_complete(env)
+        case env[:status]
+        when 400
+          raise Remind101::Error::BadInput, response_values(env)
+        when 404
+          raise Remind101::Error::ResourceNotFound, response_values(env)
+        when 422
+          raise Remind101::Error::ValidationError, response_values(env)
+        when 407
+          # mimic the behavior that we get with proxy requests with HTTPS
+          raise Remind101::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
+        when ClientErrorStatuses
+          raise Remind101::Error::ClientError, response_values(env)
+        end
+      end
+
+      def response_values(env)
+        Hashie::Mash.new status: env[:status], headers: env[:response_headers], body: env[:body]
+      end
+    end
+  end
+end

data/lib/remind101/version.rb

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

data/lib/remind101.rb

@@ -0,0 +1,40 @@
+require 'remind101/version'
+
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+
+require 'remind101/error'
+
+module Remind101
+  autoload :Configuration, 'remind101/configuration'
+  autoload :Client,        'remind101/client'
+
+  module Middleware
+    autoload :RaiseError,  'remind101/middleware/raise_error'
+  end
+
+  class << self
+
+    # Public: The configuration object.
+    #
+    # Returns a memoized Remind101::Configuration instance.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Public: Used to set global configuration.
+    #
+    # Example
+    #
+    #   Remind101.configure do |config|
+    #     config.endpoint = 'http://localhost:5000'
+    #   end
+    #
+    # Yields Remind101.configuration.
+    def configure
+      yield configuration
+    end
+
+  end
+end

data/remind101.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remind101/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'remind101'
+  spec.version       = Remind101::VERSION
+  spec.authors       = ['Eric J. Holmes']
+  spec.email         = ['eric@ejholmes.net']
+  spec.description   = %q{Ruby client for the Remind101 API.}
+  spec.summary       = %q{Ruby client for the Remind101 API.}
+  spec.homepage      = 'https://github.com/remind101/remind101.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday',               '~> 0.8'
+  spec.add_dependency 'faraday_middleware',    '~> 0.9'
+  spec.add_dependency 'hashie',                ['>= 1.2', '< 2.1']
+
+  spec.add_development_dependency 'bundler',   '~> 1.3'
+  spec.add_development_dependency 'rspec',     '~> 2.14'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency 'webmock',   '~> 1.13'
+  spec.add_development_dependency 'rake'
+end

data/spec/remind101/client_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Remind101::Client do
+  let(:class_id  ) { 1234 }
+  let(:message_id) { 4321 }
+  let(:client    ) { described_class.new }
+
+  describe '#classes' do
+    before { stub_request(:get, 'https://api.remind101.com/v2/classes') }
+
+    it 'gets the classes' do
+      client.classes
+    end
+  end
+
+  describe '#create_class' do
+    before { stub_request(:post, 'https://api.remind101.com/v2/classes') }
+
+    it 'creates the class' do
+      client.create_class name: 'Math 101'
+    end
+  end
+
+  describe '#destroy_class' do
+    before { stub_request(:delete, "https://api.remind101.com/v2/classes/#{class_id}") }
+
+    it 'destroys the class' do
+      client.destroy_class class_id
+    end
+  end
+
+  describe '#messages' do
+    before { stub_request(:get, 'https://api.remind101.com/v2/messages') }
+
+    it 'gets the messages' do
+      client.messages
+    end
+  end
+
+  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]
+    end
+  end
+
+  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
+    end
+  end
+
+  describe '#subscribers' do
+    before { stub_request(:get, "https://api.remind101.com/v2/classes/#{class_id}/subscribers") }
+
+    it 'gets the subscribers' do
+      client.subscribers(class_id)
+    end
+  end
+end

data/spec/remind101_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Remind101 do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+Bundler.require :default, :test
+
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: remind101
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for the Remind101 API.
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/remind101.rb
+- lib/remind101/client.rb
+- lib/remind101/client/classes.rb
+- lib/remind101/client/connection.rb
+- lib/remind101/client/messages.rb
+- lib/remind101/client/rescuable.rb
+- lib/remind101/client/subscribers.rb
+- lib/remind101/configuration.rb
+- lib/remind101/error.rb
+- lib/remind101/middleware/raise_error.rb
+- lib/remind101/version.rb
+- remind101.gemspec
+- spec/remind101/client_spec.rb
+- spec/remind101_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/remind101/remind101.rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -779571737398577944
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -779571737398577944
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby client for the Remind101 API.
+test_files:
+- spec/remind101/client_spec.rb
+- spec/remind101_spec.rb
+- spec/spec_helper.rb