sqwiggle-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9861f73c0c503ae86faae33ce3ee99d9eef3a174
-  data.tar.gz: 14385e245da76c95eea2e39c73f5692e597f8f28
+  metadata.gz: 14b3945293f0642e0d9270fbd303850511aa4f02
+  data.tar.gz: c72b4b53e004bdd3c9fd27c1add24cedae67962a
 SHA512:
-  metadata.gz: b34a848bd1cae0cd70750c2a9df6fcb4d95a923cd4391521241c27d29359f788ddd188a5f8739671a0efc6d0fbd57e9cb0805fbd2cd70f85e59b3f7dc8b53bfa
-  data.tar.gz: d6bfe2fc293cc46c0e8cc5a39fc1a5e31c28467d0e91706eb8433877a5e5c7e37f87956cfc4457948c32b88d7b393d0e81f2e753f25e89d80a4ed57f1e8000bc
+  metadata.gz: 5600af7ae02615d1b411d092611413f28fa2aabe8282f9a78a5e0eecdf119627606f2b5431f60da12d13d40a9c8c22edfb9207bc29bfa490c2a7bb9378076176
+  data.tar.gz: 6231e7c35e8228a53747f4243402d09416a400a61bb6c344d733ab6cf549bf029645379c95258d72ebd3de9e367b7f73c11cdf266fba6a8f4c71b78e24e012a9

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 .yardoc
 _yardoc
 doc/
+.DS_Store

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - rbx
   - ruby-head
 matrix:
@@ -20,3 +21,7 @@ matrix:
     - rvm: ruby-head
   fast_finish: true
 script: bundle exec rspec
+notifications:
+  sqwiggle: 
+    rooms:
+      - secure: GCzKzx6svwXQvRekfXojzgJsE7hJz4mb8PMy71d8AWyOYgEGAyKH9Ysb5pXQuMXlWo7esCegzci398FY9+zNzYl8RZxX4AR/uND2scaO8alp09/i6QCz/JdU8JZC5H9tSWPU6xCDAdbPb3XdEYYVZaj23Ckn7SqtYg/KngX5zs8=

data/Gemfile

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

data/README.md

@@ -1,12 +1,8 @@
 # Ruby Client for the Sqwiggle API
 
-The API and this gem are currently in ~~BETA~~ ALPHA
-
-Comments, pull requests, discussion and input are all welcome at this stage.
-
 ![Build Status](https://api.travis-ci.org/sqwiggle/sqwiggle-ruby.png)
 
-A Ruby gem for the Sqwiggle API.
+A Ruby wrapper for the Sqwiggle REST API.
 
 ## Installation
 
@@ -22,13 +18,71 @@ Or install it yourself as:
 
     $ gem install sqwiggle-ruby
 
-## Usage
+## Configuration
 
 Create an API Client at https://www.sqwiggle.com/company/clients
 
+Once you have a token there are two ways of instantiating an instance of a client.
+
+### Globally (not thread safe)
+```ruby
+Sqwiggle.token = 'your token here'
+client = Sqwiggle.client
+```
+### Locally (thread safe)
+```ruby
+client = Sqwiggle.client('your token here')
+```
+Which is basically syntactic sugar for
+```ruby
+Sqwiggle::Api::Client.new('your token here')
+```
+
+## Usage
+
+### Services
+
+A service acts a bit like an ActiveRecord relation proxy
+
+```ruby
+#load the message service
+messages = client.messages
+
+#the service currently has the following methods
+old_message = messages.find 42
+new_message = messages.new(params)
+all_messages = messages.all
+```
+
+#### Available Services
+* messages
+* invites
+* conversations
+* attachments
+* organizations
+* rooms
+* users
+
+### Resources
+Resources are not dissimilar to an ActiveResource or an ActiveRecord object
+```ruby
+#with a persisted object
+message = client.messages.find 42
+message.update(text:'the message') #fails silently
+message.update!(text:'the message') #raises a Sqwiggle::Api::Errors::BadRequestError
+
+#creating a new object
+message = client.messages.new
+message.text = 'the new message'
+message.save #fails silently
+message.save! #raises an error
+```
+
 ## TODO
 
- * Compile todo list
+ * Capistrano integration
+ * Pagination
+ * Rdoc (or similar)
 
 
 ## Contributing

data/lib/sqwiggle-ruby.rb

@@ -4,6 +4,7 @@ require 'virtus'
 
 module Sqwiggle
   module Api
+    require "sqwiggle/api"
     require "sqwiggle/api/error_handler"
     require "sqwiggle/api/service"
     require "sqwiggle/api/client"

data/lib/sqwiggle/api.rb

@@ -0,0 +1,12 @@
+module Sqwiggle
+  module Api
+    #for testing/development purposes
+    def self.url
+      @@url ||= 'https://api.sqwiggle.com/'
+    end
+
+    def self.url=(val)
+      @@url = val
+    end
+  end
+end

data/lib/sqwiggle/api/client.rb

@@ -4,7 +4,6 @@ module Sqwiggle
       class NoTokenError < StandardError;end;
 
       attr_accessor :token
-      attr_writer :url #for testing purposes
 
       def initialize(token=nil)
         unless @token = token || Sqwiggle.token
@@ -54,15 +53,12 @@ module Sqwiggle
 
       private
 
-      def url
-        @url || 'https://api.sqwiggle.com/'
-      end
-
       def connection
-        @connection ||= Faraday.new(url:url) do |f|
+        @connection ||= Faraday.new(url:Sqwiggle::Api.url) do |f|
           f.request  :url_encoded             # form-encode POST params
           f.adapter  Faraday.default_adapter  # make requests with Net::HTTP
           f.basic_auth token, 'X'
+          f.headers['User-Agent'] = "sqwiggle-ruby #{Sqwiggle::VERSION}"
           f.use ErrorHandler
         end
       end

data/lib/sqwiggle/version.rb

@@ -1,3 +1,3 @@
 module Sqwiggle
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sqwiggle-ruby.gemspec

@@ -24,7 +24,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'fuubar'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqwiggle-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Luke Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,48 +80,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  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'
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  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
@@ -137,6 +95,7 @@ files:
 - README.md
 - Rakefile
 - lib/sqwiggle-ruby.rb
+- lib/sqwiggle/api.rb
 - lib/sqwiggle/api/client.rb
 - lib/sqwiggle/api/error_handler.rb
 - lib/sqwiggle/api/errors/authentication_error.rb