quickblox-rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 694963a669f27b2ee03e195281aa3468cda2ba2b
-  data.tar.gz: 50cc70ee95e0b84634014de900634cfac75fe840
+  metadata.gz: a62c994036f7f4e4ffb461e24a664b029c9101b1
+  data.tar.gz: 30e791e6285a85be06c4d5b97e533370db23797c
 SHA512:
-  metadata.gz: dad34d550c462ac9007a1ec770f8c493b780c55fbf489b69e6cb5f1f9600bce4f129d39b4f5af01778592e2fc9cc6b8c1f3ecedfc023a404183f8e2231c38d15
-  data.tar.gz: a8ef607b86e59faef52641a1af729386fb7ad492c5b3140819404d068bfcfbdec94bbb21472ec0886ef027f797b0cb319f0db4d10e34f36558114c9f467c689d
+  metadata.gz: 6c0de68e336198bef5a9fdcb31fad0a118e10e4c6cc0fa60f2c45e5e7b68e7e759724b32c8f3f33d0828c074fe88f361cb2ab9243d175e7ef9975ca2f781ff79
+  data.tar.gz: 643788c04e8816b483de330ea719a65a29053e00899696f5c04c117c77b93107bc2bedd5c1bc13a89faf358ac98decb542a1e377ca904cf222f7799ec83b10f9

data/.gems

@@ -1,3 +1,4 @@
 cutest -v 1.2.3
 mocoso -v 1.2.3
 requests -v 1.0.0
+silueta -v 0.0.3

data/.gitignore

@@ -1 +1,2 @@
 .gs/
+*.gem

data/Makefile

@@ -1,4 +1,4 @@
 build:
-	cutest test/**/*_test.rb
+	RUBYLIB=./lib cutest test/**/*_test.rb
 
 .PHONY: build

data/README.md

@@ -2,3 +2,9 @@
 
 This is a gem to work with [Quickblox API](http://quickblox.com/developers/Overview) in Ruby.
 
+## Development
+
+1. Install [dep](https://github.com/cyx/dep) with `gem install dep`.
+2. Run `dep install` to install dependencies.
+3. Run the tests with `make`
+

data/lib/models.rb

@@ -0,0 +1,75 @@
+require "silueta"
+require "silueta/types"
+
+module Quickblox::Models
+  class Session
+    include Silueta
+
+    attribute :token
+    attribute :user_id, cast: Types::Integer
+    attribute :expiration, cast: ->(value) { value && DateTime.parse(value) }
+
+    def self.build(hash)
+      new(
+        token: hash.fetch("token"),
+        user_id: hash.fetch("user_id"),
+        expiration: hash.fetch("expiration")
+      )
+    end
+  end
+
+  class User
+    include Silueta
+
+    attribute :id, cast: Types::Integer
+    attribute :full_name
+    attribute :email
+    attribute :login
+    attribute :phone
+
+    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,
+        login: hash.fetch("login"),
+        phone: hash.fetch("phone")
+      )
+    end
+  end
+
+  class Chat
+    include Silueta
+
+    attribute :messages
+    attribute :buyer
+    attribute :seller
+
+    def self.build(messages, buyer: nil, seller: nil)
+      message_models = []
+      if buyer && seller
+        message_models = messages.map do |message|
+          Quickblox::Models::Message.new(
+            created_at: message.fetch("created_at"),
+            text: message.fetch("message"),
+            dialog_id: message.fetch("chat_dialog_id"),
+            sender: (message.fetch("sender_id") == buyer.id ? buyer : seller)
+          )
+        end
+      end
+
+      new(messages: message_models, buyer: buyer, seller: seller)
+    end
+  end
+
+  class Message
+    include Silueta
+
+    attribute :created_at
+    attribute :text
+    attribute :dialog_id
+    attribute :sender
+  end
+end
+

data/lib/quickblox.rb

@@ -1,85 +1,5 @@
-require "requests/sugar"
-require "securerandom"
-require "json"
+Quickblox = Module.new
 
-class Quickblox
-  QB_ENDPOINT = "https://api.quickblox.com".freeze
-  QB_HEADER_API_VERSION = "QuickBlox-REST-API-Version".freeze
-  QB_HEADER_TOKEN = "QB-Token".freeze
-
-  attr :auth_key,
-       :auth_secret,
-       :application_id,
-       :email,
-       :password,
-       :session
-
-  def initialize(**args)
-    @auth_key       = args.fetch(:auth_key)
-    @auth_secret    = args.fetch(:auth_secret)
-    @application_id = args.fetch(:application_id)
-    @email          = args[:email]
-    @password       = args[:password]
-  end
-
-  def create_session
-    data = {
-      "application_id" => application_id,
-      "auth_key" => auth_key,
-      "nonce" => SecureRandom.random_number(100000),
-      "timestamp" => Time.now.to_i,
-    }
-
-    data["user[email]"] = email if email
-    data["user[password]"] = password if password
-
-    signature = sign(data)
-
-    data["signature"] = signature
-
-    response = Requests.post(
-      QB_ENDPOINT + "/session.json",
-      headers: { QB_HEADER_API_VERSION => "0.1.1" },
-      data: data
-    )
-
-    if response.status == 201
-      @session = response.json.fetch("session")
-    end
-  end
-
-  def transcript(dialog_id:)
-    response = Requests.get(
-      QB_ENDPOINT + "/chat/Message.json",
-      headers: {
-        QB_HEADER_API_VERSION => "0.1.1",
-        QB_HEADER_TOKEN => session_token
-      },
-      params: {
-        chat_dialog_id: dialog_id,
-        mark_as_read: 0
-      }
-    )
-
-    if response.status == 200
-      response.json
-    end
-  end
-
-private
-
-  def sign(data)
-    normalized_string = data.each_key
-      .sort
-      .map { |key| "#{key}=#{data[key]}" }
-      .join("&")
-
-    sha1 = OpenSSL::Digest::SHA1.new
-    OpenSSL::HMAC.hexdigest(sha1, auth_secret, normalized_string)
-  end
-
-  def session_token
-    (@session || create_session).fetch("token")
-  end
-end
+require_relative "quickblox_api"
+require_relative "models"
 

data/lib/quickblox_api.rb

@@ -0,0 +1,114 @@
+require "requests/sugar"
+require "securerandom"
+require "json"
+
+class Quickblox::API
+  QB_ENDPOINT = "https://api.quickblox.com".freeze
+  QB_HEADER_API_VERSION = "QuickBlox-REST-API-Version".freeze
+  QB_HEADER_TOKEN = "QB-Token".freeze
+  QB_HEADER_EXPIRATION = "qb-token-expirationdate".freeze
+
+  attr :auth_key,
+       :auth_secret,
+       :application_id,
+       :email,
+       :password,
+       :session,
+       :last_response
+
+  def initialize(**args)
+    @auth_key       = args.fetch(:auth_key)
+    @auth_secret    = args.fetch(:auth_secret)
+    @application_id = args.fetch(:application_id)
+    @email          = args[:email]
+    @password       = args[:password]
+  end
+
+  def create_session
+    data = {
+      "application_id" => application_id,
+      "auth_key"       => auth_key,
+      "nonce"          => SecureRandom.random_number(100000),
+      "timestamp"      => Time.now.to_i,
+    }
+
+    data["user[email]"] = email if email
+    data["user[password]"] = password if password
+
+    signature = sign(data)
+
+    data["signature"] = signature
+
+    response = Requests.post(
+      QB_ENDPOINT + "/session.json",
+      headers: { QB_HEADER_API_VERSION => "0.1.1" },
+      data: data
+    )
+
+    @last_response = response
+
+    if response.status == 201
+      session = response.json.fetch("session")
+      session["expiration"] = response.headers.fetch(QB_HEADER_EXPIRATION).first
+      @session = Quickblox::Models::Session.build(session)
+    end
+  end
+
+  def find_user(user_id:)
+    response = Requests.get(
+      QB_ENDPOINT + "/users/#{user_id}.json",
+      headers: {
+        QB_HEADER_API_VERSION => "0.1.1",
+        QB_HEADER_TOKEN => session_token
+      },
+    )
+
+    @last_response = response
+
+    if response.status == 200
+      user = response.json.fetch("user")
+      Quickblox::Models::User.build(user)
+    end
+  end
+
+  def chat_transcript(dialog_id:)
+    response = Requests.get(
+      QB_ENDPOINT + "/chat/Message.json",
+      headers: {
+        QB_HEADER_API_VERSION => "0.1.1",
+        QB_HEADER_TOKEN => session_token
+      },
+      params: {
+        chat_dialog_id: dialog_id,
+        mark_as_read: 0
+      }
+    )
+
+    if response.status == 200
+      messages = response.json.fetch("items")
+
+      buyer, seller = [
+        find_user(user_id: messages.first.fetch("sender_id")),
+        find_user(user_id: messages.first.fetch("recipient_id"))
+      ]
+
+      Quickblox::Models::Chat.build(messages, buyer: buyer, seller: seller)
+    end
+  end
+
+private
+
+  def sign(data)
+    normalized_string = data.each_key
+    .sort
+    .map { |key| "#{key}=#{data[key]}" }
+    .join("&")
+
+    sha1 = OpenSSL::Digest::SHA1.new
+    OpenSSL::HMAC.hexdigest(sha1, auth_secret, normalized_string)
+  end
+
+  def session_token
+    (@session || create_session).token
+  end
+end

data/quickblox-rb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "quickblox-rb"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   s.summary = "Ruby gem to work with Quickblox API"
   s.description = s.summary
   s.authors = ["Lucas Tolchinsky"]
@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
 
   s.add_runtime_dependency "requests"
+  s.add_runtime_dependency "silueta"
 
   s.add_development_dependency "cutest"
   s.add_development_dependency "mocoso"

data/test/quickblox_api_test.rb

@@ -0,0 +1,148 @@
+require "cutest"
+require "mocoso"
+require "quickblox"
+require "date"
+require_relative "quickblox_responses"
+
+include Mocoso
+
+scope "initialization" do
+  test "with application credentials" do
+    qb = Quickblox::API.new(
+      auth_key: "AUTH_KEY",
+      auth_secret: "AUTH_SECRET",
+      application_id: 1234,
+    )
+
+    assert_equal "AUTH_KEY", qb.auth_key
+    assert_equal "AUTH_SECRET", qb.auth_secret
+    assert_equal 1234, qb.application_id
+    assert qb.email.nil?
+    assert qb.password.nil?
+  end
+
+  test "with user credentials" do
+    qb = Quickblox::API.new(
+      auth_key: "AUTH_KEY",
+      auth_secret: "AUTH_SECRET",
+      application_id: 1234,
+      email: "account@owner.com",
+      password: "foobarbaz"
+    )
+
+    assert_equal "AUTH_KEY", qb.auth_key
+    assert_equal "AUTH_SECRET", qb.auth_secret
+    assert_equal 1234, qb.application_id
+    assert_equal "account@owner.com", qb.email
+    assert_equal "foobarbaz", qb.password
+  end
+end
+
+test "#create_session" do
+  qb = Quickblox::API.new(
+    auth_key: "AUTH_KEY",
+    auth_secret: "AUTH_SECRET",
+    application_id: 1234,
+    email: "account@owner.com",
+    password: "foobarbaz"
+  )
+
+  # This is a real life example of a response to POST /session.json
+  # We only care about the expiration header.
+  mock_response = Requests::Response.new(
+    201,
+    { "qb-token-expirationdate" => ["2016-05-02 19:52:00 UTC"] },
+    QB_RESPONSES.fetch(:session)
+  )
+
+  assert qb.session.nil?
+
+  stub(Requests, :request, mock_response) { qb.create_session }
+
+  assert qb.session
+  assert_equal Quickblox::Models::Session, qb.session.class
+  assert_equal "le-token-stuff", qb.session.token
+  assert_equal DateTime.parse("2016-05-02 19:52:00 UTC"), qb.session.expiration
+end
+
+test "#last_response" do
+  qb = Quickblox::API.new(
+    auth_key: "AUTH_KEY",
+    auth_secret: "AUTH_SECRET",
+    application_id: 1234,
+    email: "account@owner.com",
+    password: "foobarbaz"
+  )
+
+  mock_response = Requests::Response.new(
+    201,
+    { "qb-token-expirationdate" => ["2016-05-02 19:52:00 UTC"] },
+    "{\"session\": {\"token\":\"le-token\",\"user_id\":\"5\"}}"
+  )
+
+  assert qb.last_response.nil?
+
+  stub(Requests, :request, mock_response) { qb.create_session }
+
+  assert_equal mock_response, qb.last_response
+end
+
+test "#find_user" do
+  qb = Quickblox::API.new(
+    auth_key: "AUTH_KEY",
+    auth_secret: "AUTH_SECRET",
+    application_id: 1234,
+    email: "account@owner.com",
+    password: "foobarbaz"
+  )
+
+  mock_response = Requests::Response.new(200, {}, QB_RESPONSES.fetch(:user))
+
+  user = stub(Requests, :request, mock_response) do
+    stub(qb, :session_token, "token") { qb.find_user(user_id: 900) }
+  end
+
+  assert user
+  assert_equal Quickblox::Models::User, user.class
+  assert_equal 900, user.id
+  assert_equal "mister@one.com", user.email
+  assert_equal "Mr One", user.full_name
+  assert_equal "1133445566", user.phone
+  assert_equal "One", user.login
+end
+
+test "#chat_transcript" do
+  qb = Quickblox::API.new(
+    auth_key: "AUTH_KEY",
+    auth_secret: "AUTH_SECRET",
+    application_id: 1234,
+    email: "account@owner.com",
+    password: "foobarbaz"
+  )
+
+  mock_response = Requests::Response.new(200, {}, QB_RESPONSES.fetch(:messages))
+
+  mock_user = Quickblox::Models::User.new(
+    id: 12243767,
+    email: "bar@foo.com",
+    full_name: "User",
+  )
+
+  chat = stub(Requests, :request, mock_response) do
+    stub(qb, :find_user,  mock_user) do
+      stub(qb, :session_token, "token") { qb.chat_transcript(dialog_id: "5727676fa28f9a49") }
+    end
+  end
+
+  assert chat
+  assert_equal Quickblox::Models::Chat, chat.class
+  assert_equal mock_user, chat.buyer
+  assert_equal mock_user, chat.seller
+  assert_equal 1, chat.messages.size
+
+  message = chat.messages.first
+  assert message
+  assert_equal Quickblox::Models::Message, message.class
+  assert_equal mock_user, message.sender
+end
+

data/test/quickblox_responses.rb

@@ -0,0 +1,5 @@
+QB_RESPONSES = {
+  session: "{\"session\":{\"_id\":\"572793c0a28f9a658800002a\",\"application_id\":35265,\"created_at\":\"2016-05-02T17:52:00Z\",\"device_id\":0,\"nonce\":29601,\"token\":\"le-token-stuff\",\"ts\":1462211496,\"updated_at\":\"2016-05-02T17:52:00Z\",\"user_id\":0,\"id\":18862}}",
+  user: "{\"user\":{\"id\":900,\"owner_id\":45,\"full_name\":\"Mr One\",\"email\":\"mister@one.com\",\"login\":\"One\",\"phone\":\"1133445566\",\"website\":null,\"created_at\":\"2016-02-10T12:07:50Z\",\"updated_at\":\"2016-03-16T17:42:27Z\",\"last_request_at\":\"2016-03-17T12:34:00Z\",\"external_user_id\":null,\"facebook_id\":null,\"twitter_id\":null,\"blob_id\":null,\"custom_data\":null,\"twitter_digits_id\":null,\"user_tags\":\"tag1,tag2\"}}",
+  messages: "{\"skip\":0,\"limit\":100,\"items\":[{\"_id\":\"5727677a28fee63e74000000\",\"attachments\":[],\"chat_dialog_id\":\"5727676fa28f9a49\",\"created_at\":\"2016-05-02T14:43:07Z\",\"date_sent\":1462200187,\"delivered_ids\":[12243767,11716786],\"message\":\"Hola buen d\xC3\xADa\",\"read_ids\":[12243767,11716786],\"recipient_id\":100,\"sender_id\":100,\"updated_at\":\"2016-05-02T15:01:48Z\",\"read\":1}]}",
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickblox-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lucas Tolchinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: silueta
+  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: cutest
   requirement: !ruby/object:Gem::Requirement
@@ -63,9 +77,12 @@ files:
 - ".gitignore"
 - Makefile
 - README.md
+- lib/models.rb
 - lib/quickblox.rb
+- lib/quickblox_api.rb
 - quickblox-rb.gemspec
-- test/quickblox_test.rb
+- test/quickblox_api_test.rb
+- test/quickblox_responses.rb
 homepage: https://github.com/properati/quickblox-rb
 licenses:
 - MIT

data/test/quickblox_test.rb

@@ -1,79 +0,0 @@
-require "cutest"
-require "mocoso"
-require_relative "../lib/quickblox"
-
-include Mocoso
-
-scope "initialization" do
-  test "with application credentials" do
-    qb = Quickblox.new(
-      auth_key: "AUTH_KEY",
-      auth_secret: "AUTH_SECRET",
-      application_id: 1234,
-    )
-
-    assert_equal "AUTH_KEY", qb.auth_key
-    assert_equal "AUTH_SECRET", qb.auth_secret
-    assert_equal 1234, qb.application_id
-    assert qb.email.nil?
-    assert qb.password.nil?
-  end
-
-  test "with user credentials" do
-    qb = Quickblox.new(
-      auth_key: "AUTH_KEY",
-      auth_secret: "AUTH_SECRET",
-      application_id: 1234,
-      email: "account@owner.com",
-      password: "foobarbaz"
-    )
-
-    assert_equal "AUTH_KEY", qb.auth_key
-    assert_equal "AUTH_SECRET", qb.auth_secret
-    assert_equal 1234, qb.application_id
-    assert_equal "account@owner.com", qb.email
-    assert_equal "foobarbaz", qb.password
-  end
-end
-
-test "create session" do
-  qb = Quickblox.new(
-    auth_key: "AUTH_KEY",
-    auth_secret: "AUTH_SECRET",
-    application_id: 1234,
-    email: "account@owner.com",
-    password: "foobarbaz"
-  )
-
-  # This is a real life example of a response to POST /session.json
-  mock_response = Requests::Response.new(
-    201,
-    {
-      "access-control-allow-origin"=>["*"],
-      "cache-control"=>["max-age=0, private, must-revalidate"],
-      "content-type"=>["application/json; charset=utf-8"],
-      "date"=>["Mon, 02 May 2016 17:52:01 GMT"],
-      "etag"=>["\"442ceb087b8b83fee1ba7f28e082caca\""],
-      "qb-token-expirationdate"=>["2016-05-02 19:52:00 UTC"],
-      "quickblox-rest-api-version"=>["0.1.1"],
-      "server"=>["nginx/1.8.1"],
-      "status"=>["201 Created"],
-      "strict-transport-security"=>["max-age=15768000;"],
-      "x-rack-cache"=>["invalidate, pass"],
-      "x-request-id"=>["2d7b3f554389b95e8561d89fc77104bd"],
-      "x-runtime"=>["0.014038"],
-      "x-ua-compatible"=>["IE=Edge,chrome=1"],
-      "content-length"=>["259"],
-      "connection"=>["keep-alive"]
-    },
-    "{\"session\":{\"_id\":\"572793c0a28f9a658800002a\",\"application_id\":35265,\"created_at\":\"2016-05-02T17:52:00Z\",\"device_id\":0,\"nonce\":29601,\"token\":\"le-token-stuff\",\"ts\":1462211496,\"updated_at\":\"2016-05-02T17:52:00Z\",\"user_id\":0,\"id\":18862}}"
-  )
-
-  assert qb.session.nil?
-
-  stub(Requests, :request, mock_response) { qb.create_session }
-
-  assert qb.session
-  assert_equal "le-token-stuff", qb.session.fetch("token")
-end
-