quickblox-rb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e377ebc8c37c660d792ca2c9cdf4f79cffbe660
-  data.tar.gz: 3015e3ca62ca96333a72bdfa672f5eb3fd37e160
+  metadata.gz: 4f4740bda5465f46b1f3c9dd2321aaaa2b5e5428
+  data.tar.gz: b882aa81e405f1d845232e04b3309cb0fe515386
 SHA512:
-  metadata.gz: 0cfaae607b05a0e0eaa23f2192d702b1e8780fe31545e92a3d888caabed7a9eaffbae191dd6a0746779a317abad3a05900df0f9d926ad1c7d7621341fe5c9d08
-  data.tar.gz: 06c41ebc410955294692754dd549715075803fd41697d2ef30b38d41a7f909ba3bec5023ba6e7c7a933912d8dca21b1b7329650f5ba761a7d8c2257303db230c
+  metadata.gz: e070f238a42d8ef3e2a97821394b6f66922c84d2576750365d18ccdc7b61ab1b20a0e450ba0324c6983717dd00cb6627ce635f02584c1ceda6d9c3ca4093d668
+  data.tar.gz: d94f4698d3964e202c6bf76e470602500d43dcad0ca6ac9061b8608d2dc7e09c10ee6f14e329323dcbd58a3921b3b7a18ec189b1292f3a5285c0706fbd47c42f

data/README.md

@@ -2,6 +2,69 @@
 
 This is a gem to work with [Quickblox API](http://quickblox.com/developers/Overview) in Ruby.
 
+## Use
+
+It all starts by creating a `Quickblox::API` instance with your credentials.
+
+```ruby
+require "quickblox"
+
+qb_api = Quickblox::API.new(
+  auth_key: "AUTH_KEY",
+  auth_secret: "AUTH_SECRET",
+  application_id: 1234,
+  email: "account@owner.com",
+  password: "foobarbaz"
+)
+```
+
+This will create a user-level token associated to the account with `email` and `password`.
+
+If you don't provide `email` nor `password`, it'll create an application level token.
+
+You don't need to worry about the token itself when using `quickblox-rb`, but it's important to keep in mind that the actions you can make with the API are associated with the token's access right. More about this [here](http://quickblox.com/developers/Authentication_and_Authorization#Access_Rights).
+
+Now you can query the API.
+
+```ruby
+qb_api.create_session
+# All the methods below use `create_session` if they have to. No need to call it explicitly.
+
+qb_api.get_user(id: 1234)
+
+qb_api.get_dialog(id: "dialog-id")
+
+qb_api.get_messages(dialog_id: "dialog-id")
+
+qb_api.chat_transcript(dialog_id: "dialog-id")
+```
+
+These methods return instances of `Quickblox::Models`. I encourage you to [read the source](https://github.com/properati/quickblox-rb/blob/master/lib/models.rb) [and tests](https://github.com/properati/quickblox-rb/blob/master/test/quickblox_api_test.rb) to find more about them.
+
+### Other nice things
+
+Use `Quickblox::API#last_response` to inspect the HTTP response of your latest request. Useful for debugging!
+
+```ruby
+qb_api.get_user(id: 123)
+
+qb_api.last_response
+```
+
+Inspect your current session:
+
+```ruby
+qb_api.create_session
+
+qb_api.session
+```
+
+## Install
+
+```
+$ gem install quickblox-rb
+```
+
 ## Development
 
 1. Install [dep](https://github.com/cyx/dep) with `gem install dep`.

data/lib/models.rb

@@ -32,17 +32,18 @@ module Quickblox::Models
     attribute :email
     attribute :login
     attribute :phone
-    attribute :tags
+    attribute :tags, cast: ->(value) { value && value.split(",") }
+    attribute :custom_data
 
     def self.build(hash)
-      email = hash.fetch("email") || JSON.parse(hash.fetch("custom_data")).fetch("email")
       new(
         id: hash.fetch("id"),
         full_name: hash.fetch("full_name"),
-        email: email,
+        email: hash.fetch("email"),
         login: hash.fetch("login"),
         phone: hash.fetch("phone"),
-        tags: hash.fetch("user_tags")
+        tags: hash.fetch("user_tags"),
+        custom_data: hash.fetch("custom_data")
       )
     end
   end

data/lib/quickblox.rb

@@ -1,5 +1,5 @@
 Quickblox = Module.new
 
-require_relative "quickblox_api"
+require_relative "api"
 require_relative "models"
 

data/quickblox-rb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "quickblox-rb"
-  s.version = "0.1.2"
+  s.version = "0.1.3"
   s.summary = "Ruby gem to work with Quickblox API"
   s.description = s.summary
   s.authors = ["Lucas Tolchinsky"]

data/test/{quickblox_api_test.rb → api_test.rb}

@@ -109,6 +109,8 @@ test "#get_user" do
   assert_equal "Mr One", user.full_name
   assert_equal "1133445566", user.phone
   assert_equal "One", user.login
+  assert_equal ["tag1", "tag2"], user.tags
+  assert user.custom_data.nil?
 end
 
 test "#get_dialog" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickblox-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lucas Tolchinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
@@ -77,11 +77,11 @@ files:
 - ".gitignore"
 - Makefile
 - README.md
+- lib/api.rb
 - lib/models.rb
 - lib/quickblox.rb
-- lib/quickblox_api.rb
 - quickblox-rb.gemspec
-- test/quickblox_api_test.rb
+- test/api_test.rb
 - test/quickblox_responses.rb
 homepage: https://github.com/properati/quickblox-rb
 licenses: