clever-ruby 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 1.9.2
+
+script: "bundle exec rake"
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clever-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Rafael Garcia
+
+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,35 @@
+# Clever::Ruby
+
+[![Build Status](https://travis-ci.org/Clever/clever-ruby.png)](https://travis-ci.org/Clever/clever-ruby)
+
+Ruby bindings to the Clever API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clever-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clever-ruby
+
+## Usage
+
+Configure clever-ruby to use your Clever API key:
+
+    Clever.configure do |config|
+      config.api_key = 'YOUR-API-KEY'
+    end
+
+## 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,21 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+require 'clever-ruby/version'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "clever-ruby #{Clever::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/clever-ruby.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clever-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "clever-ruby"
+  gem.version       = Clever::VERSION
+  gem.authors       = ["Rafael Garcia", "Alex Zylman"]
+  gem.email         = ["ruby@getclever.com"]
+  gem.description   = %q{Ruby bindings to the Clever API.}
+  gem.summary       = %q{Ruby bindings to the Clever API.}
+  gem.homepage      = "http://github.com/Clever/clever-ruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency     'multi_json',  '~> 1.5.0'
+  gem.add_runtime_dependency     'rest-client', '~> 1.6.7'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest',    '~> 4.4.0'
+  gem.add_development_dependency 'shoulda',     '~> 3.3.2'
+  gem.add_development_dependency 'rdoc',        '~> 3.12'
+  gem.add_development_dependency 'vcr',         '~> 2.4.0'
+  gem.add_development_dependency 'webmock',     '~> 1.9.0'
+end

data/lib/clever-ruby.rb

@@ -0,0 +1,161 @@
+require 'rest_client'
+require 'multi_json'
+
+require 'clever-ruby/version'
+
+# API operations
+require 'clever-ruby/api_operations/list'
+
+# Helpers
+require 'clever-ruby/util'
+require 'clever-ruby/json'
+require 'clever-ruby/configuration'
+
+# Resources
+require 'clever-ruby/clever_object'
+require 'clever-ruby/api_resource'
+require 'clever-ruby/district'
+require 'clever-ruby/school'
+require 'clever-ruby/student'
+require 'clever-ruby/section'
+require 'clever-ruby/teacher'
+
+# Errors
+require 'clever-ruby/errors/clever_error'
+require 'clever-ruby/errors/authentication_error'
+require 'clever-ruby/errors/api_error'
+
+module Clever
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def api_key
+      configuration.api_key
+    end
+
+    def configuration
+      @configuration ||= Clever::Configuration.new
+    end
+
+    def api_url(url = '')
+      configuration.api_base + url
+    end
+  end
+
+  def self.request(method, url, params=nil, headers={})
+    raise AuthenticationError.new('No API key provided. (HINT: set your API key using "Clever.configure { |config| config.api_key = <API-KEY> }")') unless Clever.api_key
+
+    params = Util.objects_to_ids(params)
+    url = self.api_url(url)
+
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      # Make params into GET parameters
+      if params && params.count
+        query_string = Util.flatten_params(params).collect{|p| "#{p[0]}=#{p[1]}"}.join('&')
+        url += "?#{query_string}"
+      end
+      payload = nil
+    else
+      payload = params
+    end
+
+    opts = {
+      :user => Clever.api_key,
+      :password => "",
+      :method => method,
+      :url => url,
+      :headers => headers,
+      :open_timeout => 30,
+      :payload => payload,
+      :timeout => 80
+    }
+
+    begin
+      response = execute_request(opts)
+    rescue SocketError => e
+      self.handle_restclient_error(e)
+    rescue NoMethodError => e
+      # Work around RestClient bug
+      if e.message =~ /\WRequestFailed\W/
+        e = APIConnectionError.new('Unexpected HTTP response code')
+        self.handle_restclient_error(e)
+      else
+        raise
+      end
+    rescue RestClient::ExceptionWithResponse => e
+      if rcode = e.http_code and rbody = e.http_body
+        self.handle_api_error(rcode, rbody)
+      else
+        self.handle_restclient_error(e)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      self.handle_restclient_error(e)
+    end
+
+    rbody = response.body
+    rcode = response.code
+    begin
+      # Would use :symbolize_names => true, but apparently there is
+      # some library out there that makes symbolize_names not work.
+      resp = Clever::JSON.load(rbody)
+    rescue MultiJson::DecodeError
+      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+    end
+
+    resp = Util.symbolize_names(resp)
+    resp
+  end
+
+  private
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def self.handle_restclient_error(e)
+    case e
+    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+      message = "Could not connect to Clever (#{@@api_base}). Please check your internet connection and try again."
+    when SocketError
+      message = "Unexpected error communicating when trying to connect to Clever. HINT: You may be seeing this message because your DNS is not working. To check, try running 'host getclever.com' from the command line."
+    else
+      message = "Unexpected error communicating with Clever."
+    end
+    message += "\n\n(Network error: #{e.message})"
+    raise APIConnectionError.new(message)
+  end
+
+  def self.handle_api_error(rcode, rbody)
+    begin
+      error_obj = Clever::JSON.load(rbody)
+      error_obj = Util.symbolize_names(error_obj)
+      error = error_obj[:error] or raise StripeError.new # escape from parsing
+    rescue MultiJson::DecodeError, StripeError
+      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+    end
+
+    case rcode
+    when 400, 404 then
+      raise invalid_request_error(error, rcode, rbody, error_obj)
+    when 401
+      raise authentication_error(error, rcode, rbody, error_obj)
+    else
+      raise api_error(error, rcode, rbody, error_obj)
+    end
+  end
+
+  def self.invalid_request_error(error, rcode, rbody, error_obj)
+    InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj)
+  end
+
+  def self.authentication_error(error, rcode, rbody, error_obj)
+    AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.api_error(error, rcode, rbody, error_obj)
+    APIError.new(error[:message], rcode, rbody, error_obj)
+  end
+end

data/lib/clever-ruby/api_operations/list.rb

@@ -0,0 +1,16 @@
+module Clever
+  module APIOperations
+    module List
+      module ClassMethods
+        def all(filters={})
+          response = Clever.request(:get, url, filters)
+          Util.convert_to_clever_object(response[:data])
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/clever-ruby/api_resource.rb

@@ -0,0 +1,30 @@
+module Clever
+  class APIResource < CleverObject
+    def self.url
+      if self == APIResource
+        raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (School, Student, etc.)')
+      end
+      shortname = self.name.split('::')[-1]
+      "/#{CGI.escape(shortname.downcase)}s"
+    end
+
+    def url
+      unless id = self['id']
+        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
+      end
+      "#{self.class.url}/#{CGI.escape(id)}"
+    end
+
+    def refresh
+      response = Clever.request(:get, url)
+      refresh_from(response[:data])
+      self
+    end
+
+    def self.retrieve(id)
+      instance = self.new(id)
+      instance.refresh
+      instance
+    end
+  end
+end

data/lib/clever-ruby/clever_object.rb

@@ -0,0 +1,126 @@
+module Clever
+  class CleverObject
+    include Enumerable
+
+    @@permanent_attributes = Set.new([])
+
+    # The default :id method is deprecated and isn't useful to us
+    if method_defined?(:id)
+      undef :id
+    end
+
+    def initialize(id=nil)
+      @values = {}
+      @values[:id] = id if id
+    end
+
+    def self.construct_from(values)
+      obj = self.new(values[:id])
+      obj.refresh_from(values)
+      obj
+    end
+
+    def to_s(*args)
+      Clever::JSON.dump(@values, :pretty => true)
+    end
+
+    def inspect()
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + Clever::JSON.dump(@values, :pretty => true)
+    end
+
+    def refresh_from(values, partial=false)
+
+      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      added = Set.new(values.keys - @values.keys)
+
+      instance_eval do
+        remove_accessors(removed)
+        add_accessors(added)
+      end
+      removed.each do |k|
+        @values.delete(k)
+      end
+      values.each do |k, v|
+        # Stripe apparently allows you to have nested object types (e.g.
+        # InvoiceList of Charges). We don't and this was breaking our code
+        # @values[k] = Util.convert_to_clever_object(v)
+        @values[k] = v
+      end
+    end
+
+    def [](k)
+      k = k.to_sym if k.kind_of?(String)
+      @values[k]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(*a)
+      Clever::JSON.dump(@values)
+    end
+
+    def as_json(*a)
+      @values.as_json(*a)
+    end
+
+    def to_hash
+      @values
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    def ==( other )
+      if other.respond_to?( :values )
+        self.values == other.values
+      end
+    end
+
+    protected
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def remove_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@permanent_attributes.include?(k)
+          k_eq = :"#{k}="
+          remove_method(k) if method_defined?(k)
+          remove_method(k_eq) if method_defined?(k_eq)
+        end
+      end
+    end
+
+    def add_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@permanent_attributes.include?(k)
+          k_eq = :"#{k}="
+          define_method(k) { @values[k] }
+          define_method(k_eq) do |v|
+            @values[k] = v
+          end
+        end
+      end
+    end
+
+    def method_missing(name, *args)
+      return @values[name] if @values.has_key?(name)
+      super
+    end
+  end
+end