sendbird 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9309d8d962f105c291bf02cc4fe16950693ff74
-  data.tar.gz: 1a96fb5eafcf935d5adff257ab1dcdfc843c6832
+SHA256:
+  metadata.gz: bee1eb2534381eecf9283f4c80570797c2074fa653b9de44a6be8684442abac2
+  data.tar.gz: 4385f9bb5ec81bf97843b635be5c9624014bfdba2a1505c7b0ae5bd980bac8cd
 SHA512:
-  metadata.gz: 5b186e7c854d59b6f588feb7a6ad53efdf822d117c6c665c3269d0bf295a4039151f2e753a74bac4f250cf84e919b22366cd5c97a95904de9deb7339add47650
-  data.tar.gz: 56557a62ae679e8d2285f3b667ddddd211aebbfb18f9f9b0f610d104fc5775238315488cbdbfaa97b8be73d657674a72a94a169f86708de17c0264419b2970e4
+  metadata.gz: 12b030843cee3da667ab677565fe7c1e046ec81b38d9967f575a76f4fbd0e1e6e39c212e28fb33accd68fae81052b728dba8ce223373726fae029f164ff5562c
+  data.tar.gz: da18d261cd1cdc12155d28977ad37fa32542044382cc38369659fec904e6eca298cef0274c9429f31527de424fcaf807b7b544c0deb22176466d93815d81f2ab

data/README.md

@@ -46,10 +46,10 @@ The Sendbird Api is quite big, to understand how to work with this gem, just rem
 Example:
 ```ruby
 body = {
-    "user_id" => "string",               
-    "nickname" => "string",   
-    "profile_url" => "string",   
-    "issue_access_token" => "boolean"  
+    "user_id" => "string",
+    "nickname" => "string",
+    "profile_url" => "string",
+    "issue_access_token" => "boolean"
 }
 Sendbird::UserApi.create(body)
 ```
@@ -60,9 +60,9 @@ Example for event [Message send](https://docs.sendbird.com/platform#messages):
 ```ruby
 request_body = {
     "message_type" => "MESG",
-    "user_id" => "string",     
-    "message" => "string",     
-    "data" => "string",        
+    "user_id" => "string",
+    "message" => "string",
+    "data" => "string",
     "mark_as_read" => "boolean"
 }
 Sendbird::MessageApi.send('group_channels', 'group_channels_url', request_body)
@@ -72,7 +72,7 @@ Example for event [User list](https://docs.sendbird.com/platform#messages):
 ```ruby
 request_parameters = {
     "token" => "string",
-    "limit" => "int",     
+    "limit" => "int",
     "user_ids" => "string"
 }
 Sendbird::UserApi.list(request_parameters)
@@ -82,7 +82,7 @@ Example for sending a message to a different app:
 ```ruby
 request_parameters = {
   "token" => "string",
-  "limit" => "int",     
+  "limit" => "int",
   "user_ids" => "string",
   "app" => 'string' # This app has to be in the configuration
 }
@@ -97,159 +97,8 @@ All methods return a `Sendbird::Response` with have the next methods:
 #### error_code
   Returns the error_code from the request, if their is one
 #### error_message
-  Returns the error_message from the request, if their is one  
+  Returns the error_message from the request, if their is one
 
-## List of all classes and it's class methods.
-
-### Sendbird::UserApi
-```ruby
-view(user_id)
-create(body)
-destroy(user_id)
-list(params={})
-update(user_id, body)
-unread_count(user_id)
-activate(user_id, body)
-block(user_id, body)
-unblock(user_id, unblock_user_id)
-block_list(user_id, params={})
-mark_as_read_all(user_id)
-register_gcm_token(user_id, token)
-register_apns_token(user_id, token)
-unregister_gcm_token(user_id, token)
-unregister_apns_token(user_id, token)
-unregister_all_device_token(user_id)
-push_preferences(user_id)
-update_push_preferences(user_id, body)
-delete_push_preferences(user_id)
-```  
-
-### Sendbird::OpenChannelApi
-```ruby
-view(channel_url, params={})
-create(body={})
-list(params={})
-destroy(channel_url)
-update(channel_url, body)
-participants(channel_url, params)
-freeze(channel_url, body)
-ban_user(channel_url, body)
-ban_list(channel_url, params={})
-ban_update(channel_url, user_id, body)
-ban_delete(channel_url, user_id)
-ban_view(channel_url, user_id)
-mute(channel_url, body)
-mute_list(channel_url, params={})
-mute_delete(channel_url, user_id)
-mute_view(channel_url, user_id)
-```
-
-### Sendbird::GroupChannelApi
-```ruby
-create(body)
-list(params={})
-update(channel_url, body)
-destroy(channel_url)
-view(channel_url, params={})
-members(channel_url, params={})
-is_member?(channel_url, user_id)
-invite(channel_url, body)
-hide(channel_url, body)
-leave(channel_url, body)
-```
-
-### Sendbird::MetaCounterApi && Sendbird::MetaDataApi
-```ruby
-create(channel_type, channel_url, body)
-view(channel_type, channel_url, params={})
-view_by_key(channel_type, channel_url, key)
-update(channel_type, channel_url, body)
-update_by_key(channel_type, channel_url, key, body)
-destroy(channel_type, channel_url)
-destroy_by_key(channel_type, channel_url, key)
-```
-
-### Sendbird::ApplicationApi
-```ruby
-create(body)
-list(params={})
-destroy_all
-destroy
-profanaty(body={})
-ccu
-mau(params={})
-dau(params={})
-daily_message_count(params={})
-gcm_push_configuration
-apns_push_configuration
-```
-
-## Interface
-
-This is the second type of class inside the gem, acts as interface.
-
-Currently only supporting `User`, in the future I will add the rest of interfaces.
-
-There are three ways to interact with the user interface:
-
-#### Block
-```ruby
-Sendbird::User.new('testing_user_interface_1') do |u|
-  u.nickname('Yolo')
-  u.profile_url('udbue')
-  u.timezone('Europe/London')
-  u.request!
-end
-```
-
-#### Chain Methods
-```ruby
-user = Sendbird::User.new('testing_user_interface_1')
-user.nickname('Yolo').profile_url('udbue').timezone('Europe/London').request!
-```
-
-#### Simple methods
-```ruby
-user = Sendbird::User.new('testing_user_interface_1')
-user.nickname='Yolo'
-user.profile_url=('udbue')
-user.timezone=('Europe/London')
-user.request!
-```
-
-This interface provide you with multiple methods to work with the Sendbird Api:
-
-```ruby
-user_information=(user_information={})
-nickname=(nickname)
-profile_url=(profile_url)
-issue_access_token=(issue_access_token)
-push_preferences=(push_preferences={})
-timezone=(timezone)  
-start_hour=(start_hour)
-end_hour=(end_hour)
-start_min=(start_min)
-end_min=(end_min)
-activate
-deactivate  
-mark_as_read_all
-register_gcm_token(token)
-register_apns_token(token)
-unregister_gcm_token(token)
-unregister_apns_token(token)
-unregister_all_device_token
-```  
-
-The interface will store all the pending requests called before the `request!`, when triggering the `request!` method will optimize how many request, have to be done, you don't have to worry about that.
-
-The User interface also provide some attributes: `gcm_tokens` and `apns_tokens`, they will store the different token this user have, so by triggering any of the `register_*` methods will store or remove from this attributes.
-
-The user interface also provide some getter methods that will execute the request instantly, this methods return the info response body. This methods are:
-```ruby
-get_user  
-get_unread_count
-get_push_preferences
-```
 
 ## Development
 

data/lib/sendbird.rb

@@ -2,15 +2,11 @@ require "sendbird/client"
 require "sendbird/configuration"
 require "sendbird/invalid_request"
 require "sendbird/response"
-require "sendbird/request_handler"
 require "sendbird/application_api"
 require "sendbird/user_api"
-require "sendbird/user"
 require "sendbird/open_channel_api"
 require "sendbird/group_channel_api"
-require "sendbird/group_channel"
 require "sendbird/message_api"
-require "sendbird/message"
 require "sendbird/meta_base"
 require "sendbird/meta_data_api"
 require "sendbird/meta_counter_api"

data/lib/sendbird/version.rb

@@ -1,3 +1,3 @@
 module Sendbird
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/sendbird.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendbird
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - GustavoCaso
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -131,20 +130,14 @@ files:
 - lib/sendbird/application_api.rb
 - lib/sendbird/client.rb
 - lib/sendbird/configuration.rb
-- lib/sendbird/group_channel.rb
 - lib/sendbird/group_channel_api.rb
 - lib/sendbird/invalid_request.rb
-- lib/sendbird/message.rb
 - lib/sendbird/message_api.rb
 - lib/sendbird/meta_base.rb
 - lib/sendbird/meta_counter_api.rb
 - lib/sendbird/meta_data_api.rb
 - lib/sendbird/open_channel_api.rb
-- lib/sendbird/request_handler.rb
-- lib/sendbird/request_handler/request.rb
-- lib/sendbird/request_handler/request_merger.rb
 - lib/sendbird/response.rb
-- lib/sendbird/user.rb
 - lib/sendbird/user_api.rb
 - lib/sendbird/version.rb
 - sendbird.gemspec
@@ -167,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Sendbird Platform API

data/lib/sendbird/group_channel.rb

@@ -1,52 +0,0 @@
-module Sendbird
-  class GroupChannel
-    class MissingUserId < StandardError; end
-    include RequestHandler
-
-    api_class GroupChannelApi
-    default_arg :channel_url
-
-    attr_reader :channel_url, :user_id, :pending_requests
-    def initialize(channel_url, user_id = :missing_user_id)
-      @channel_url = channel_url
-      @user_id = user_id
-      @pending_requests = {}
-      yield(self) if block_given?
-    end
-
-    def name=(name)
-      merge_arguments(:update, {name: name})
-      self
-    end
-
-    def cover_url=(cover_url)
-      merge_arguments(:update, {cover_url: cover_url})
-      self
-    end
-
-    def data=(data)
-      merge_arguments(:update, {data: data})
-      self
-    end
-
-    def is_distinct=(is_distinct)
-      merge_arguments(:update, {is_distinct: is_distinct})
-      self
-    end
-
-    def send_message(type, data)
-      message.send(type, data)
-    end
-
-    def message
-      return @message if defined?(@message)
-      if user_id == :missing_user_id
-        raise MissingUserId, 'Please provide an user_id at initialize to been able to use send_message'
-      end
-      @message ||= Message.new(user_id, channel_url, 'group_channels')
-    end
-
-    private
-    attr_writer :pending_requests
-  end
-end

data/lib/sendbird/message.rb

@@ -1,44 +0,0 @@
-module Sendbird
-  class Message
-    class InvalidMessageType < StandardError; end
-    attr_reader :user_id, :channel_url, :channel_type
-
-    def initialize(user_id, channel_url, channel_type)
-      @user_id = user_id
-      @channel_url = channel_url
-      @channel_type = channel_type
-    end
-
-    def send(type, data)
-      MessageApi.send(channel_type, channel_url, message_body(type).merge(data))
-      self
-    end
-
-    private
-    def message_type(type)
-      case type
-      when :text then 'MESG'
-      when :file then 'FILE'
-      when :admin then 'ADMM'
-      else
-        raise InvalidMessageType, "Please provide a valid message type, valid types are: [:text, :file, :admin]"
-      end
-    end
-
-    def message_body(type)
-      case type
-      when :text, :file
-        {
-          "message_type": message_type(type),
-          "user_id": user_id
-        }
-      when :admin
-        {
-          "message_type": message_type(type),
-        }
-      else
-        raise InvalidMessageType, "Please provide a valid message type, valid types are: [:text, :file, :admin]"
-      end
-    end
-  end
-end

data/lib/sendbird/request_handler.rb

@@ -1,41 +0,0 @@
-require_relative "./request_handler/request"
-require_relative "./request_handler/request_merger"
-
-module Sendbird
-  module RequestHandler
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    def request!
-        Request.new(pending_requests, api_class, default_arg).execute
-      rescue InvalidRequest => e
-        raise e
-      ensure
-        self.pending_requests = {}
-      self
-    end
-
-    def merge_arguments(method, args, callback=nil)
-      self.pending_requests = RequestMerger.call(pending_requests, method, args, callback)
-    end
-
-    def default_arg
-      self.send(self.class.instance_variable_get(:@default_arg))
-    end
-
-    def api_class
-      self.class.instance_variable_get(:@api_class)
-    end
-
-    module ClassMethods
-      def api_class(api_class)
-        @api_class = api_class
-      end
-
-      def default_arg(method)
-        @default_arg = method
-      end
-    end
-  end
-end

data/lib/sendbird/request_handler/request.rb

@@ -1,41 +0,0 @@
-module Sendbird
-  module RequestHandler
-    class Request
-      attr_reader :pending_requests, :api_class, :default_argument
-      def initialize(pending_requests, api_class, default_argument)
-        @pending_requests = pending_requests
-        @api_class = api_class
-        @default_argument = default_argument
-      end
-
-      def execute
-        pending_requests.each do |method, params|
-          response = case params[:args]
-                     when Array
-                       if params[:args].any?
-                         api_class.send(method, default_argument, *params[:args])
-                       else
-                         api_class.send(method, default_argument)
-                       end
-                     when Hash
-                       api_class.send(method, default_argument, params[:args])
-                     end
-          handle_response_status(response, method, params[:args])
-          execute_callbacks(params[:callback], response)
-        end
-      end
-
-      def handle_response_status(response, method, arguments)
-        if response.status != 200
-          raise InvalidRequest, "#{response.error_message} executing #{method} with arguments: #{arguments}"
-        end
-      end
-
-      def execute_callbacks(callbacks, response)
-        callbacks.each do |cb|
-          cb.call(response)
-        end
-      end
-    end
-  end
-end

data/lib/sendbird/request_handler/request_merger.rb

@@ -1,44 +0,0 @@
-module Sendbird
-  module RequestHandler
-    class RequestMerger
-      def self.call(pending_requests, method, args, callback)
-        new(pending_requests, method, args, callback).merge
-      end
-
-      attr_reader :pending_requests, :method, :args, :callback
-      def initialize(pending_requests, method, args, callback)
-        @pending_requests = pending_requests
-        @method = method
-        @args = args
-        @callback = callback
-      end
-
-      def merge
-        pending_requests[method] ||= {}
-        case args
-        when Hash
-          merge_hash_arguments(args)
-        else
-          merge_rest_of_arguments(args)
-        end
-        append_callbacks(args)
-        pending_requests
-      end
-
-      def merge_hash_arguments(args)
-        pending_requests[method][:args] ||= {}
-        pending_requests[method][:args] = pending_requests[method][:args].merge(args)
-      end
-
-      def merge_rest_of_arguments(args)
-        pending_requests[method][:args] ||= []
-        pending_requests[method][:args] = pending_requests[method][:args] << args if args
-      end
-
-      def append_callbacks(args)
-        pending_requests[method][:callback] ||= []
-        pending_requests[method][:callback] = pending_requests[method][:callback] << callback if callback
-      end
-    end
-  end
-end

data/lib/sendbird/user.rb

@@ -1,178 +0,0 @@
-module Sendbird
-  class User
-    include RequestHandler
-
-    api_class UserApi
-    default_arg :user_id
-
-    attr_reader :user_id, :pending_requests, :gcm_tokens, :apns_tokens
-    def initialize(user_id)
-      @user_id = user_id
-      @gcm_tokens = []
-      @apns_tokens = []
-      @pending_requests = {}
-      yield(self) if block_given?
-    end
-
-    def in_sync?
-      pending_requests.empty?
-    end
-
-    #Getters
-    def get_user
-      response = UserApi.view(user_id)
-      if response.status == 200
-        response.body
-      else
-        raise InvalidRequest.new(
-          error_message(
-            response.error_message,
-            __method__,
-            user_id
-          )
-        )
-      end
-    end
-
-    def get_unread_count
-      response = UserApi.unread_count(user_id)
-      if response.status == 200
-        response.body['unread_count']
-      else
-        raise InvalidRequest.new(
-          error_message(
-            response.error_message,
-            __method__,
-            user_id
-          )
-        )
-      end
-    end
-
-    def get_push_preferences
-      response = UserApi.push_preferences(user_id)
-      if response.status == 200
-        response.body
-      else
-        raise InvalidRequest.new(
-          error_message(
-            response.error_message,
-            __method__,
-            user_id
-          )
-        )
-      end
-    end
-
-    # Setters
-    def user_information=(user_information={})
-      merge_arguments(:update, user_information)
-      self
-    end
-    alias_method :user_information, :user_information=
-
-    def nickname=(nickname)
-      merge_arguments(:update, {nickname: nickname})
-      self
-    end
-    alias_method :nickname, :nickname=
-
-    def profile_url=(profile_url)
-      merge_arguments(:update, {profile_url: profile_url})
-      self
-    end
-    alias_method :profile_url, :profile_url=
-
-    def issue_access_token=(issue_access_token)
-      merge_arguments(:update, {issue_access_token: issue_access_token})
-      self
-    end
-    alias_method :issue_access_token, :issue_access_token=
-
-    def activate
-      merge_arguments(:activate, { activate: true })
-      self
-    end
-
-    def deactivate
-      merge_arguments(:activate, { activate: false })
-      self
-    end
-
-    def push_preferences=(push_preferences={})
-      merge_arguments(:update_push_preferences, push_preferences)
-      self
-    end
-    alias_method :push_preferences, :push_preferences=
-
-    def timezone=(timezone)
-      merge_arguments(:update_push_preferences, { timezone: timezone })
-      self
-    end
-    alias_method :timezone, :timezone=
-
-    def start_hour=(start_hour)
-      merge_arguments(:update_push_preferences, { start_hour: start_hour })
-      self
-    end
-    alias_method :start_hour, :start_hour=
-
-    def end_hour=(end_hour)
-      merge_arguments(:update_push_preferences, { end_hour: end_hour })
-      self
-    end
-    alias_method :end_hour, :end_hour=
-
-    def start_min=(start_min)
-      merge_arguments(:update_push_preferences, { start_min: start_min })
-      self
-    end
-    alias_method :start_min, :start_min=
-
-    def end_min=(end_min)
-      merge_arguments(:update_push_preferences, { end_min: end_min })
-      self
-    end
-    alias_method :end_min, :end_min=
-
-    def register_gcm_token(token)
-      merge_arguments(:register_gcm_token, token, ->(response){ self.gcm_tokens << response.body['token'] })
-      self
-    end
-
-    def register_apns_token(token)
-      merge_arguments(:register_apns_token, token, ->(response){ self.apns_tokens << response.body['token'] })
-      self
-    end
-
-    def unregister_gcm_token(token)
-      merge_arguments(:unregister_gcm_token, token, ->(response){ self.gcm_tokens.delete(response.body['token'])})
-      self
-    end
-
-    def unregister_apns_token(token)
-      merge_arguments(:unregister_apns_token, token, ->(response){ self.apns_tokens.delete(response.body['token'])})
-      self
-    end
-
-    def unregister_all_device_token
-      merge_arguments(:unregister_all_device_token, nil, ->(response) { self.apns_tokens = []; self.gcm_tokens = []; })
-      self
-    end
-
-    def mark_as_read_all
-      merge_arguments(:mark_as_read_all, {})
-      self
-    end
-
-    def group_channel(channel_url)
-      GroupChannel.new(channel_url, user_id)
-    end
-
-    private
-    attr_writer :pending_requests, :apns_tokens, :gcm_tokens
-    def error_message(error_message, method_name, args)
-      "Invalid request for User with user_id: #{user_id}, error message: #{error_message} the request method was #{method_name} with args: #{args}"
-    end
-  end
-end