sqwiggle/sqwiggle-ruby

A Ruby gem for the Sqwiggle API

Ruby Client for the Sqwiggle API

A Ruby wrapper for the Sqwiggle REST 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

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)

Sqwiggle.token = 'your token here'
client = Sqwiggle.client

Locally (thread safe)

client = Sqwiggle.client('your token here')

Which is basically syntactic sugar for

Sqwiggle::Api::Client.new('your token here')

Usage

Services

A service acts a bit like an ActiveRecord relation proxy

#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

#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

• Capistrano integration
• Pagination
• Rdoc (or similar)

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

sqwiggle-ruby's Issues

all objects represented

Raise an error with bang methods

How to require / use this gem?

I'm not a ruby dev, just trying to hack an API call into an existing app, and I can't for the life of me figure out how.

Using the code in the 'local' example gives me an 'uninitialized constant' error.

I've tried adding require 'sqwiggle-ruby' and require 'sqwiggle'

I'm sure I'm missing something simple that all ruby devs would know, but I'm stuck! Thanks in advance for your help :)

P.S. sorry accidentally hit enter before I finished writing this

Stream ID not supported?

We've started getting Sqwiggle::Api::Errors::BadRequestError because we're not including a stream_id. But as far as I can tell, I can't provide a stream_id with the Ruby client. Am I missing something?

Add ruby 2.1 to travis

Pass user agent string in faraday headers

activities end point

Development deps in Gemfile not gemspec

I'm not sure if this is a problem. I usually use the gemspec where I can and use the Gemfile for gems from git repos and local dirs.

Two license files

WTF

contact request endpoint

update user endpoint

to match new schema

update conversation endpoint

doesnt need room id etc