sqwiggle-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01fdd1607b0180d92e3f9ca6c1f9dfe1e3445154
+  data.tar.gz: 3dbf59ea942e0c1dc08939f41cda5074e41b7085
+SHA512:
+  metadata.gz: 3a2072b170981a7a5e09af1f4997fd9ca8a8a1c7ccf847838169390e98d808aec4b4978b712ab2e30d6b9cf5e3e8315af8c78621fe8a2e5342eb5536d8cc18c3
+  data.tar.gz: 2a2ffc8b4474f777804ac47aec0ab17b6c706ade7dcdf4620066abbe9be268a51c1b5b5b2633267d6fcf114b56ef2d8ff108e1bf77d4642020935513d341273b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.travis.yml

@@ -0,0 +1,22 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-20mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx
+    - rvm: ruby-head
+  fast_finish: true
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'webmock'
+gem 'fuubar'
+
+# Specify your gem's dependencies in sqwiggle-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Sqwiggle
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Luke Roberts
+
+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,31 @@
+# Sqwiggle::Ruby
+
+![Build Status](https://api.travis-ci.org/sqwiggle/sqwiggle-ruby.png)
+
+A Ruby gem for the Sqwiggle API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sqwiggle-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqwiggle-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/sqwiggle/client.rb

@@ -0,0 +1,47 @@
+module Sqwiggle
+  class Client
+    class NoTokenError < StandardError;end;
+
+    attr_accessor :token
+    attr_writer :url #for testing purposes
+
+    def initialize(token=nil)
+      unless @token = token || Sqwiggle.token
+        raise NoTokenError 
+      end
+    end
+
+    def ==(val)
+      self.class == val.class && val.token == token
+    end
+
+    def get(endpoint, params={})
+      connection.get endpoint, params
+    end
+
+    def messages
+      Service.new Message, self
+    end
+
+    def users
+      Service.new User, self
+    end
+
+    private
+
+    def url
+      @url || 'https://api.sqwiggle.com/'
+    end
+
+    def connection
+      @connection ||= Faraday.new(url:url) do |f|
+        f.request  :url_encoded             # form-encode POST params
+        f.response :logger                  # log requests to STDOUT
+        f.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        f.basic_auth token, 'X'
+        f.use ErrorHandler
+      end
+    end
+
+  end
+end

data/lib/sqwiggle/error_handler.rb

@@ -0,0 +1,12 @@
+module Sqwiggle
+  class ErrorHandler < Faraday::Response::Middleware
+    def on_complete(env)
+      raise Errors::BadRequestError         if env[:status] == 400
+      raise Errors::AuthenticationError     if env[:status] == 401
+      raise Errors::PaymentRequiredError    if env[:status] == 402
+      raise Errors::AuthorizationError      if env[:status] == 403
+      raise Errors::NotFoundError           if env[:status] == 404
+      raise Errors::ServerError             if env[:status] == 500
+    end
+  end
+end

data/lib/sqwiggle/errors/authentication_error.rb

@@ -0,0 +1,6 @@
+module Sqwiggle
+  module Errors
+    class AuthenticationError < StandardError;end;
+  end
+end
+

data/lib/sqwiggle/errors/authorization_error.rb

@@ -0,0 +1,5 @@
+module Sqwiggle
+  module Errors
+    class AuthorizationError < StandardError;end;
+  end
+end

data/lib/sqwiggle/errors/bad_request_error.rb

@@ -0,0 +1,6 @@
+module Sqwiggle
+  module Errors
+    class BadRequestError < StandardError;end;
+  end
+end
+

data/lib/sqwiggle/errors/not_found_error.rb

@@ -0,0 +1,5 @@
+module Sqwiggle
+  module Errors
+    class NotFoundError < StandardError;end;
+  end
+end

data/lib/sqwiggle/errors/payment_required_error.rb

@@ -0,0 +1,5 @@
+module Sqwiggle
+  module Errors
+    class PaymentRequiredError < StandardError;end;
+  end
+end

data/lib/sqwiggle/errors/server_error.rb

@@ -0,0 +1,5 @@
+module Sqwiggle
+  module Errors
+    class ServerError < StandardError;end;
+  end
+end

data/lib/sqwiggle/invite.rb

@@ -0,0 +1,6 @@
+module Sqwiggle
+  class Invite < Resource
+    self.endpoint = '/invites'
+    attribute :email, String
+  end
+end

data/lib/sqwiggle/message.rb

@@ -0,0 +1,13 @@
+module Sqwiggle
+  class Message < Resource
+
+    attribute :text, String
+    attribute :type, String
+    attribute :author, Hash
+
+    def author
+      #overriding logic here
+    end
+
+  end
+end

data/lib/sqwiggle/resource.rb

@@ -0,0 +1,39 @@
+module Sqwiggle
+  class Resource
+    
+    include Virtus.model
+
+    attribute :client, Client, default: :default_client 
+    attribute :id, Integer
+
+    def default_client
+      Client.new
+    end
+
+    class << self
+      
+      attr_accessor :endpoint
+
+      def all(client=Client.new)
+        [].tap do |result|
+          JSON.parse(client.get(self.endpoint).body).each do |item|
+            result << self.new(item)
+          end
+        end
+      end
+
+      def find(id, client=Client.new)
+        self.new(JSON.parse(client.get("#{endpoint}/#{id}").body))
+      end
+
+      def endpoint
+        @endpoint || default_endpoint
+      end
+
+      def default_endpoint
+        "/#{self.to_s.downcase.split('::').last}s"
+      end
+
+    end
+  end
+end

data/lib/sqwiggle/service.rb

@@ -0,0 +1,19 @@
+module Sqwiggle
+  class Service
+
+    attr_reader :klass, :client
+
+    def initialize(klass, client)
+      @klass, @client = klass, client
+    end
+
+    def all
+      klass.all client
+    end
+
+    def find(id)
+      klass.find id, client
+    end
+
+  end
+end

data/lib/sqwiggle/user.rb

@@ -0,0 +1,6 @@
+module Sqwiggle
+  class User < Resource
+    self.endpoint = '/users'
+    attribute :name
+  end
+end

data/lib/sqwiggle/version.rb

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

data/lib/sqwiggle-ruby.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'json'
+require 'virtus'
+
+require "sqwiggle/version"
+
+require "sqwiggle/error_handler"
+require "sqwiggle/service"
+require "sqwiggle/client"
+require "sqwiggle/resource"
+
+require "sqwiggle/errors/authentication_error"
+require "sqwiggle/errors/authorization_error"
+require "sqwiggle/errors/bad_request_error"
+require "sqwiggle/errors/not_found_error"
+require "sqwiggle/errors/payment_required_error"
+require "sqwiggle/errors/server_error"
+
+require "sqwiggle/invite"
+require "sqwiggle/message"
+require "sqwiggle/user"
+
+module Sqwiggle
+  class << self
+    attr_accessor :token
+  end
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Sqwiggle::Client do
+
+
+  describe ".new" do
+    before do
+      Sqwiggle.token = nil
+    end
+    context "with a globally specified token" do
+      before do
+        Sqwiggle.token = 'global_token'
+      end
+      context "without specifying a token in the initializer" do
+        subject { Sqwiggle::Client.new }
+        its(:token) { should be == 'global_token' }
+      end
+      context "with specifying a token in the initializer" do
+        subject { Sqwiggle::Client.new 'local_token' }
+        its(:token) { should be == 'local_token' }
+      end
+    end
+    context "without a globally specified token" do
+      it "Raises an error" do
+        expect { Sqwiggle::Client.new }.to raise_error(Sqwiggle::Client::NoTokenError)
+      end
+    end
+  end
+
+  describe "#get" do
+    subject { Sqwiggle::Client.new 'local_token' }
+    let(:endpoint) { '/users/1' }
+
+    it "delegates to Faraday" do
+      Faraday::Connection.any_instance.should_receive(:get).with(endpoint, {})
+      subject.get endpoint
+    end
+  end
+
+end

data/spec/errors_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe "api error handling" do
+
+  context "400" do
+    before do
+      Sqwiggle.token = 'token'
+
+      stub_request(:get, "https://token:X@api.sqwiggle.com/messages").to_return({
+        :body => "[]", 
+        :status => 400, 
+        :headers => { 'Content-Length' => 3 }
+      })
+    end
+
+    it "raises an exception" do
+      expect{Sqwiggle::Message.all}.to raise_error(Sqwiggle::Errors::BadRequestError)
+    end
+
+  end
+
+  context "401" do
+    before do
+      Sqwiggle.token = 'token'
+
+      stub_request(:get, "https://token:X@api.sqwiggle.com/messages").to_return({
+        :body => "[]", 
+        :status => 401, 
+        :headers => { 'Content-Length' => 3 }
+      })
+    end
+
+    it "raises an exception" do
+      expect{Sqwiggle::Message.all}.to raise_error(Sqwiggle::Errors::AuthenticationError)
+    end
+  end
+
+  context "402" do
+    before do
+      Sqwiggle.token = 'token'
+
+      stub_request(:get, "https://token:X@api.sqwiggle.com/messages").to_return({
+        :body => "[]", 
+        :status => 402, 
+        :headers => { 'Content-Length' => 3 }
+      })
+    end
+
+    it "raises an exception" do
+      expect{Sqwiggle::Message.all}.to raise_error(Sqwiggle::Errors::PaymentRequiredError)
+    end
+  end
+
+  context "403" do
+    before do
+      Sqwiggle.token = 'token'
+
+      stub_request(:get, "https://token:X@api.sqwiggle.com/messages").to_return({
+        :body => "[]", 
+        :status => 403, 
+        :headers => { 'Content-Length' => 3 }
+      })
+    end
+
+    it "raises an exception" do
+      expect{Sqwiggle::Message.all}.to raise_error(Sqwiggle::Errors::AuthorizationError)
+    end
+  end
+
+  context "404" do
+    before do
+      Sqwiggle.token = 'token'
+
+      stub_request(:get, "https://token:X@api.sqwiggle.com/messages").to_return({
+        :body => "[]", 
+        :status => 404, 
+        :headers => { 'Content-Length' => 3 }
+      })
+    end
+
+    it "raises an exception" do
+      expect{Sqwiggle::Message.all}.to raise_error(Sqwiggle::Errors::NotFoundError)
+    end
+  end
+
+  context "500" do
+    before do
+      Sqwiggle.token = 'token'
+
+      stub_request(:get, "https://token:X@api.sqwiggle.com/messages").to_return({
+        :body => "[]", 
+        :status => 500, 
+        :headers => { 'Content-Length' => 3 }
+      })
+    end
+
+    it "raises an exception" do
+      expect{Sqwiggle::Message.all}.to raise_error(Sqwiggle::Errors::ServerError)
+    end
+  end
+
+end

data/spec/message_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Sqwiggle::Message do
+
+  it_behaves_like "a resource"
+
+  before do
+    Sqwiggle.token = 'some_token'
+  end
+
+  describe "initialization" do
+    it "accepts a hash" do
+      m = Sqwiggle::Message.new({text:'some text'})
+      m.text.should be == 'some text'
+    end
+
+    it "ignores extraneous values hash" do
+      m = Sqwiggle::Message.new({text:'some text', extraneous:1})
+      m.text.should be == 'some text'
+    end
+  end
+end

data/spec/resource_behaviour.rb

@@ -0,0 +1,6 @@
+shared_examples_for "a resource" do
+  subject { described_class.new }
+  specify { subject.should respond_to :id }
+  specify { subject.client.should be == Sqwiggle::Client.new }
+end
+

data/spec/resource_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Sqwiggle::Resource do
+  
+  let(:client) { double('mock_client') }
+  let(:response) { double('faraday_response') }
+
+  before do
+    client.stub(:get).and_return(response)
+    Sqwiggle.token = 'some client'
+  end
+
+  describe ".all" do
+    it "calls the index endpoint" do
+      response.stub(:body).and_return("[{\"a\":1,\"b\":2}]")
+      client.should_receive(:get).with('/resources')
+      Sqwiggle::Resource.all(client)
+    end
+  end
+
+  describe ".all" do
+    it "calls the index endpoint" do
+      response.stub(:body).and_return("{\"a\":1,\"b\":2}")
+      client.should_receive(:get).with('/resources/1')
+      Sqwiggle::Resource.find(1, client)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/sqwiggle-ruby'
+require 'rspec'
+require 'webmock/rspec'
+require 'resource_behaviour'

data/spec/sqwiggle_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Sqwiggle do
+  specify { Sqwiggle }
+  specify { Sqwiggle::Client }
+  specify { Sqwiggle::Message }
+
+  describe ".token=" do
+    before do
+      Sqwiggle.token = 'token'
+    end
+    specify { Sqwiggle.token.should be == 'token' }
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Sqwiggle::User do
+  it_behaves_like "a resource"
+end
+

data/sqwiggle-ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sqwiggle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sqwiggle-ruby"
+  spec.version       = Sqwiggle::VERSION
+  spec.authors       = ["Luke Roberts"]
+  spec.email         = ["luke@sqwiggle.com"]
+  spec.description   = %q{Ruby wrapper for the sqwiggle API}
+  spec.summary       = %q{Ruby wrapper for the sqwiggle API}
+  spec.homepage      = ""
+  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'
+  spec.add_dependency 'virtus'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: sqwiggle-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luke Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the sqwiggle API
+email:
+- luke@sqwiggle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sqwiggle-ruby.rb
+- lib/sqwiggle/client.rb
+- lib/sqwiggle/error_handler.rb
+- lib/sqwiggle/errors/authentication_error.rb
+- lib/sqwiggle/errors/authorization_error.rb
+- lib/sqwiggle/errors/bad_request_error.rb
+- lib/sqwiggle/errors/not_found_error.rb
+- lib/sqwiggle/errors/payment_required_error.rb
+- lib/sqwiggle/errors/server_error.rb
+- lib/sqwiggle/invite.rb
+- lib/sqwiggle/message.rb
+- lib/sqwiggle/resource.rb
+- lib/sqwiggle/service.rb
+- lib/sqwiggle/user.rb
+- lib/sqwiggle/version.rb
+- spec/client_spec.rb
+- spec/errors_spec.rb
+- spec/message_spec.rb
+- spec/resource_behaviour.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+- spec/sqwiggle_spec.rb
+- spec/user_spec.rb
+- sqwiggle-ruby.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the sqwiggle API
+test_files:
+- spec/client_spec.rb
+- spec/errors_spec.rb
+- spec/message_spec.rb
+- spec/resource_behaviour.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+- spec/sqwiggle_spec.rb
+- spec/user_spec.rb