zquickblox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcaf9cf04e084b207a4263b090224e1a11d7f709
+  data.tar.gz: 4c9ed23995354ae230db4328229dfc1b08542560
+SHA512:
+  metadata.gz: f128d1c6cae4757bc255c5cd1a8c89c380ddae31f0529f1c6170f019c644c363f8e5ae0ed4ae69e2ddb1288b4e8a0aa273e8650deca5124f2dd43ba7098897d7
+  data.tar.gz: 9e49cb0b7ed112e5acde9b389f4bc405afb75af2ce04caab0b446cad26c27394d6458e35559347d39f744b46aa3401c8467e88bbb7b638c4082f6a3513bfc6eb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at thuongnh.uit@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zquickblox.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thuong Nguyen
+
+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,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thuong Nguyen
+
+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,54 @@
+# Zquickblox
+
+This gem is a Quickblox API client in Ruby. Normally, we will use Javascript or mobile SDK, but in some cases where server needs to control things, this gem will play its role.
+
+Currently this gem ONLY supports creating users on Quickblox (used for signing up user).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zquickblox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zquickblox
+
+## Usage
+
+You need to generate an initializer for ZQuickblox in order to config your Quickblox app:
+
+```ruby
+rails generate zquickblox:config
+```
+
+To create a new user, just call:
+
+```ruby
+ZQuickblox::User.create({email: "abc@email.com", password: "a_password"})
+```
+
+There are more params for you to set:
+
+```ruby
+login, password, email, blob_id, external_user_id, facebook_id, twitter_id, full_name, phone, website
+```
+
+## Error handling
+
+During the API processing, errors may occur. In such cases, `ZQuickblox::Error` (subclass of StandardError) will be thrown with `messages` as an array of string error messages.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zelic91/zquickblox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs       << "lib/zquickblox"
+  t.test_files = FileList['test/lib/zquickblox/**']
+  t.verbose    = true
+end
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zquickblox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/initializer_generator.rb

@@ -0,0 +1,5 @@
+class InitializerGenerator < Rails::Generators::Base
+  def create_config
+    template "zquickblox", "config/initializers/zquickblox.rb"
+  end
+end

data/lib/generators/templates/zquickblox.rb

@@ -0,0 +1,5 @@
+ZQuickblox.configure do |config|
+  config.app_id      = ENV['QB_APP_ID'],
+  config.auth_key    = ENV['QB_AUTH_KEY'],
+  config.auth_secret = ENV['QB_AUTH_SECRET']
+end

data/lib/zquickblox/error.rb

@@ -0,0 +1,3 @@
+module ZQuickblox
+  class Error < StandardError; end
+end

data/lib/zquickblox/request.rb

@@ -0,0 +1,79 @@
+module ZQuickblox
+  class Request
+    API_ENDPOINT = "https://api.quickblox.com"
+
+    attr_accessor :params, :headers, :method, :response, :response_body, :errors
+    attr_reader :connection
+    attr_reader :uri
+
+    def initialize
+      @connection = Faraday.new(url: Request::API_ENDPOINT) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+      end
+
+      @headers = {}
+    end
+
+    def header(key, value)
+      headers[key] = value
+    end
+
+    def before_request
+    end
+
+    def after_request
+    end
+
+    def execute
+      before_request
+
+      get    if @method == :get
+      post   if @method == :post
+      put    if @method == :put
+      delete if @method == :delete
+
+      @response_body = JSON.parse(@response.body)
+
+      @errors = @response_body["errors"]
+      if @errors
+        raise ZQuickblox::Error.new(messages: @errors["base"])
+      end
+
+      after_request
+    end
+
+    private
+
+    def handle_request(request)
+      request.url        @uri
+      request.headers =  @headers
+      request.body    =  @params
+    end
+
+    def get
+      @response = @connection.get do |request|
+        handle_request(request)
+      end
+    end
+
+    def post
+      @response = @connection.post do |request|
+        handle_request(request)
+      end
+    end
+
+    def put
+      @response = @connection.put do |request|
+        handle_request(request)
+      end
+    end
+
+    def delete
+      @response = @connection.delete do |request|
+        handle_request(request)
+      end
+    end
+  end
+end

data/lib/zquickblox/session.rb

@@ -0,0 +1,41 @@
+module ZQuickblox
+  class Session < Request
+    attr_reader :token, :session
+
+    class << self
+      def create
+        session = ZQuickblox::Session.new
+        session.execute
+        return session
+      end
+    end
+
+    def initialize
+      super
+      @uri = "/session.json"
+      @method = :post
+    end
+
+    def before_request
+      build_params
+    end
+
+    def execute
+      super
+      @session = @response_body["session"]
+      @token   = @session["token"]
+    end
+
+    private
+
+    def build_params
+      @params = {
+        application_id: ZQuickblox.config.app_id,
+        auth_key: ZQuickblox.config.auth_key,
+        timestamp: Time.now.to_i,
+        nonce: rand(2000)
+      }
+      @params[:signature] = ZQuickblox::Signature.generate_signature(@params, ZQuickblox.config.auth_secret)
+    end
+  end
+end

data/lib/zquickblox/signature.rb

@@ -0,0 +1,22 @@
+module ZQuickblox
+  module Signature
+    class << self
+      def generate_signature(params, secret)
+        pairs = params.map { |key, value| "#{key}=#{value}" }
+        pairs.sort!
+        body  = pairs.join("&")
+        return hmac_sha(body, secret)
+      end
+
+      private
+
+      def hmac_sha(data, secret)
+        require "base64"
+        require "cgi"
+        require "openssl"
+        hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), secret.encode("ASCII"), data.encode("ASCII"))
+        return hmac
+      end
+    end
+  end
+end

data/lib/zquickblox/user/create_user_request.rb

@@ -0,0 +1,12 @@
+module ZQuickblox
+  module User
+    class CreateUserRequest < Request
+      def initialize(params)
+        super()
+        @uri    = "/users.json"
+        @method = :post
+        @params = params
+      end
+    end
+  end
+end

data/lib/zquickblox/user.rb

@@ -0,0 +1,56 @@
+require_relative "user/create_user_request"
+
+module ZQuickblox
+  module User
+    class << self
+      def create(params)
+        user = User.new(params)
+        params = user.build_params
+        request = ZQuickblox::User::CreateUserRequest.new(params)
+        run_request(request)
+        user = User.new(ZQuickblox::Util.symbolize_keys(request.response_body["user"]))
+        return user
+      end
+
+      def run_request(request)
+        session = ZQuickblox::Session.create
+        request.header("QB-Token", session.token)
+        request.execute
+      end
+    end
+
+    class User
+      attr_accessor :id, :login, :password, :email, :blob_id, :external_user_id
+      attr_accessor :facebook_id, :twitter_id, :full_name, :phone, :website
+
+      def initialize(params)
+        @id               = params[:id]
+        @login            = params[:login]
+        @password         = params[:password]
+        @email            = params[:email]
+        @blob_id          = params[:blob_id]
+        @external_user_id = params[:external_user_id]
+        @facebook_id      = params[:facebook_id]
+        @twitter_id       = params[:twitter_id]
+        @full_name        = params[:full_name]
+        @phone            = params[:phone]
+        @website          = params[:website]
+      end
+
+      def build_params
+        @params = {
+          "user[login]":            @login,
+          "user[password]":         @password,
+          "user[email]":            @email,
+          "user[blob_id]":          @blob_id,
+          "user[external_user_id]": @external_user_id,
+          "user[facebook_id]":      @facebook_id,
+          "user[twitter_id]":       @twitter_id,
+          "user[full_name]":        @full_name,
+          "user[phone]":            @phone,
+          "user[website]":          @website
+        }
+      end
+    end
+  end
+end

data/lib/zquickblox/util.rb

@@ -0,0 +1,11 @@
+module ZQuickblox
+  module Util
+    class << self
+      def symbolize_keys(hash)
+        new_hash = Hash.new
+        hash.each { |key, value| new_hash[key.to_sym] = value }
+        return new_hash
+      end
+    end
+  end
+end

data/lib/zquickblox/version.rb

@@ -0,0 +1,3 @@
+module ZQuickblox
+  VERSION = "0.1.0"
+end

data/lib/zquickblox.rb

@@ -0,0 +1,24 @@
+require_relative "zquickblox/version"
+require_relative "zquickblox/error"
+require_relative "zquickblox/request"
+require_relative "zquickblox/signature"
+require_relative "zquickblox/session"
+require_relative "zquickblox/user"
+require_relative "zquickblox/util"
+require "faraday"
+require "json"
+
+module ZQuickblox
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(self.config)
+  end
+
+  class Config
+    attr_accessor :app_id, :auth_key, :auth_secret
+  end
+end

data/zquickblox.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zquickblox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zquickblox"
+  spec.version       = ZQuickblox::VERSION
+  spec.authors       = ["Thuong Nguyen"]
+  spec.email         = ["thuongnh.uit@gmail.com"]
+
+  spec.summary       = %q{A good friend of Quickblox.}
+  spec.description   = %q{A simple API client for Quickblox in Ruby.}
+  spec.homepage      = "https://github.com/zelic91/zquickblox"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|generators)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rails",   ">= 3.0.0"
+  spec.add_runtime_dependency     "faraday", ">= 0.9.2"
+  spec.add_runtime_dependency     "json",    ">= 1.8.3"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: zquickblox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thuong Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: A simple API client for Quickblox in Ruby.
+email:
+- thuongnh.uit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/initializer_generator.rb
+- lib/generators/templates/zquickblox.rb
+- lib/zquickblox.rb
+- lib/zquickblox/error.rb
+- lib/zquickblox/request.rb
+- lib/zquickblox/session.rb
+- lib/zquickblox/signature.rb
+- lib/zquickblox/user.rb
+- lib/zquickblox/user/create_user_request.rb
+- lib/zquickblox/util.rb
+- lib/zquickblox/version.rb
+- zquickblox.gemspec
+homepage: https://github.com/zelic91/zquickblox
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.4
+signing_key: 
+specification_version: 4
+summary: A good friend of Quickblox.
+test_files: []
+has_rdoc: