ringcentral_sdk 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c23194e018c633da22f300e1946b31798aee7695
-  data.tar.gz: 38c033f1d88b89c6acd62c90174da19bc4744ceb
+  metadata.gz: 83d46bb9ba9b0eed4874438f1532291460c09ea9
+  data.tar.gz: 48825a7449dc3675fa5898ac8526433e8e1c10c8
 SHA512:
-  metadata.gz: 3ace1d77ae6ab01725f2176afae51424979b0bc4d329a94890a0fb41b3174b035f37506dad8a05c38d66d6e88ba4b5ce6e2767d4e269363477e28c1f969052e0
-  data.tar.gz: 421025b7312c80738f1bfd4e6453b7e7a3bd62b1939231383045bb93af28398cff7aa01ee9a84183ffc8258453c68b9498f3cd617bf4faed6102de82434e87b0
+  metadata.gz: 0a87654d4ce18fcae34692bba5da3823889cbb03c0e481fb338a93c3f22d9813ee4ad2f5a8399ab14650230003ad09eb41296415fe0364e9b94d09d6b2b61c6b
+  data.tar.gz: 7e2104f2d664a74fe4ce36db59c26ef92a773cce28c174052fe1a9ff1451ef4b89151d4310d1f7eada45b01136500b547f31eb016088994700dfad04bc1ecfc7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 CHANGELOG
 ---------
+- **2017-04-01**: 2.1.0
+  - Additions
+    - Add SMS/MMS helper and demo
+  - Update
+    - Refactor Fax helper
 - **2016-12-28**: 2.0.2
   - Update
     - Update to add retry for `504` error code as default in addition to `429`, `503`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ringcentral_sdk (2.0.1)
+    ringcentral_sdk (2.1.0)
       dotenv (~> 2.1, >= 2.1.0)
       faraday (~> 0, >= 0)
       faraday_middleware (~> 0, >= 0)
@@ -36,28 +36,28 @@ GEM
       timers (>= 4.1.1)
     celluloid-supervision (0.20.6)
       timers (>= 4.1.1)
-    concurrent-ruby (1.0.3)
-    coveralls (0.8.17)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.20)
       json (>= 1.8, < 3)
-      simplecov (~> 0.12.0)
+      simplecov (~> 0.14.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
+      thor (~> 0.19.4)
       tins (~> 1.6)
     docile (1.1.5)
-    dotenv (2.1.1)
-    dry-configurable (0.5.0)
+    dotenv (2.2.0)
+    dry-configurable (0.6.2)
       concurrent-ruby (~> 1.0)
     dry-container (0.6.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.2.1)
+    dry-core (0.2.4)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.2.0)
-    dry-logic (0.4.0)
+    dry-logic (0.4.1)
       dry-container (~> 0.2, >= 0.2.6)
-      dry-core (~> 0.1)
+      dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-types (0.9.3)
+    dry-types (0.9.4)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1)
       dry-container (~> 0.3)
@@ -65,28 +65,27 @@ GEM
       dry-equalizer (~> 0.2)
       dry-logic (~> 0.4, >= 0.4.0)
       inflecto (~> 0.0.0, >= 0.0.2)
-    dry-validation (0.10.4)
+    dry-validation (0.10.5)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-      dry-container (~> 0.2, >= 0.2.8)
       dry-core (~> 0.2, >= 0.2.1)
       dry-equalizer (~> 0.2)
       dry-logic (~> 0.4, >= 0.4.0)
       dry-types (~> 0.9, >= 0.9.0)
-    faraday (0.9.2)
+    faraday (0.11.0)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.1)
+    faraday_middleware (0.11.0.1)
       faraday (>= 0.7.4, < 1.0)
     faraday_middleware-oauth2_refresh (0.0.3)
       faraday (~> 0.9, >= 0.9)
       faraday_middleware (~> 0, >= 0)
-    faraday_middleware-request-retry (0.1.0)
+    faraday_middleware-request-retry (0.2.0)
       faraday (~> 0, >= 0)
       faraday_middleware (~> 0, >= 0)
     hitimes (1.2.4)
     httpclient (2.8.3)
     inflecto (0.0.2)
-    json (2.0.2)
+    json (2.0.3)
     jsondoc (0.1.3)
     jwt (1.5.6)
     logger (1.2.8)
@@ -104,33 +103,33 @@ GEM
     multi_json (1.12.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
-    oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    power_assert (0.4.1)
-    pubnub (4.0.17)
+    power_assert (1.0.1)
+    pubnub (4.0.19)
       celluloid (~> 0.17)
       dry-validation (~> 0.10)
       httpclient (~> 2.8)
       json (>= 1.8, < 3)
     rack (2.0.1)
     rake (12.0.0)
-    simplecov (0.12.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    term-ansicolor (1.4.0)
+    term-ansicolor (1.5.0)
       tins (~> 1.0)
     test-unit (3.2.3)
       power_assert
     thor (0.19.4)
     timers (4.1.2)
       hitimes
-    tins (1.13.0)
+    tins (1.13.2)
 
 PLATFORMS
   ruby
@@ -145,4 +144,4 @@ DEPENDENCIES
   test-unit (~> 3)
 
 BUNDLED WITH
-   1.13.6
+   1.13.7

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2016 John Wang
+Copyright (c) 2015-2017 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -24,8 +24,8 @@ RingCentral SDK for Ruby
   1. [Synopsis](#synopsis)
   1. [API Requests](#api-requests)
     1. [Generic HTTP Requests](#generic-http-requests)
-    2. [SMS Example](#sms-example)
-    3. [Fax Example](#fax-example)
+    2. [SMS and MMS Examples](#sms-and-mms-examples)
+    3. [Fax Examples](#fax-examples)
   1. [Advanced Use Cases](#advanced-use-cases)
 5. [Supported Ruby Versions](#supported-ruby-versions)
 6. [Releases](#releases)
@@ -130,7 +130,9 @@ This is useful to access many API endpoints which do not have custom wrappers an
 http = client.http
 ```
 
-#### SMS Example
+#### SMS and MMS Examples
+
+SMS:
 
 ```ruby
 client.messages.sms.create(
@@ -140,7 +142,18 @@ client.messages.sms.create(
 )
 ```
 
-#### Fax Example
+MMS with media file:
+
+```ruby
+client.messages.sms.create(
+  from: '+16505551212',
+  to: '+14155551212',
+  text: 'Hi there!',
+  media: '/filepath/to/file.ext'
+)
+```
+
+#### Fax Examples
 
 Fax files:
 
@@ -170,20 +183,20 @@ To make subscriptions with RingCentral, use the SDK object to create subscriptio
 # Create an observer object
 class MyObserver
   def update(message)
-    puts "Subscription Message Received"
+    puts 'Subscription Message Received'
     puts JSON.dump(message)
   end
 end
 
 # Create an observable subscription and add your observer
-sub = client.create_subscription()
-sub.add_observer(MyObserver.new())
+sub = client.create_subscription
+sub.add_observer MyObserver.new
 
 # Subscribe to an arbitrary number of event filters
-sub.subscribe(['/restapi/v1.0/account/~/extension/~/presence'])
+sub.subscribe ['/restapi/v1.0/account/~/extension/~/presence']
 
 # End the subscription
-sub.destroy()
+sub.destroy
 ```
 
 ### Advanced Use Cases
@@ -238,7 +251,7 @@ RingCentral Official SDKs
 
 RingCentral SDK is available under an MIT-style license. See [LICENSE.md](LICENSE.md) for details.
 
-RingCentral SDK © 2015-2016 by John Wang
+RingCentral SDK © 2015-2017 by John Wang
 
  [gem-version-svg]: https://badge.fury.io/rb/ringcentral_sdk.svg
  [gem-version-link]: http://badge.fury.io/rb/ringcentral_sdk

data/lib/ringcentral_sdk.rb

@@ -1,6 +1,6 @@
 # RingCentralSdk is a SDK for the RingCentral REST API
 module RingCentralSdk
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.1.0'.freeze
 
   RC_SERVER_PRODUCTION = 'https://platform.ringcentral.com'.freeze
   RC_SERVER_SANDBOX = 'https://platform.devtest.ringcentral.com'.freeze

data/lib/ringcentral_sdk/rest/messages.rb

@@ -7,8 +7,8 @@ module RingCentralSdk
 
       def initialize(client)
         @client = client
-        @sms = RingCentralSdk::REST::MessagesSMS.new(client)
-        @fax = RingCentralSdk::REST::MessagesFax.new(client)
+        @sms = RingCentralSdk::REST::MessagesSMS.new client
+        @fax = RingCentralSdk::REST::MessagesFax.new client
       end
     end
   end
@@ -16,23 +16,27 @@ end
 
 module RingCentralSdk
   module REST
-    # MessagesSMS provides a helper for SMS messages
+    # MessagesSMS provides a helper for SMS and MMS messages
     class MessagesSMS
       def initialize(client)
         @client = client
       end
 
       def create(opts)
-        response = @client.http.post do |req|
-          req.url 'account/~/extension/~/sms'
-          req.headers['Content-Type'] = 'application/json'
-          req.body = {
-            from: { phoneNumber: opts[:from].to_s },
-            to: [{ phoneNumber: opts[:to].to_s }],
-            text: opts[:text].to_s
-          }
+        req = RingCentralSdk::REST::Request::SMS.new
+        req.add_metadata({
+          to: opts[:to],
+          from: opts[:from],
+          text: opts[:text]
+        })
+        if opts.key? :media
+          if opts[:media].is_a? String
+            req.add_file opts[:media]
+          elsif opts[:media].is_a? Array
+            req.add_files opts[:media]
+          end
         end
-        response
+        @client.send_request req
       end
     end
   end
@@ -47,8 +51,29 @@ module RingCentralSdk
       end
 
       def create(opts)
-        fax = RingCentralSdk::REST::Request::Fax.new opts
-        @client.send_request fax
+        req = RingCentralSdk::REST::Request::Fax.new
+        meta = {}
+
+        skip = {text: 1, files: 1}
+
+        opts.each do |k,v|
+          meta[k] = v unless skip.key? k
+        end
+
+        req.add_metadata meta
+
+        if opts.key? :text
+          req.add_text opts[:text]
+        end
+
+        if opts.key? :files
+          if opts[:files].is_a? String
+            req.add_file opts[:files]
+          elsif opts[:files].is_a? Array
+            req.add_files opts[:files]
+          end
+        end
+        @client.send_request req
       end
     end
   end

data/lib/ringcentral_sdk/rest/request.rb

@@ -3,9 +3,11 @@ module RingCentralSdk
     # Request is the module namespace for various API request helpers.
     module Request
       autoload :Base, 'ringcentral_sdk/rest/request/base'
+      autoload :BaseMultipart, 'ringcentral_sdk/rest/request/base_multipart'
       autoload :Fax, 'ringcentral_sdk/rest/request/fax'
       autoload :Inflator, 'ringcentral_sdk/rest/request/inflator'
       autoload :Simple, 'ringcentral_sdk/rest/request/simple'
+      autoload :SMS, 'ringcentral_sdk/rest/request/sms'
     end
   end
 end

data/lib/ringcentral_sdk/rest/request/base_multipart.rb

@@ -0,0 +1,94 @@
+require 'base64'
+require 'mime'
+require 'mime/types'
+require 'mime_builder'
+require 'multi_json'
+
+module RingCentralSdk
+  module REST
+    module Request
+      # BaseMultipart is a base reqwuest helper class for multipart/mixed messages
+      class BaseMultipart < RingCentralSdk::REST::Request::Base
+        CONTENT_ID_HEADER = 'Content-Id'.freeze
+        DEFAULT_METHOD = 'post'.freeze
+        DEFAULT_ID = '~'.freeze
+        DEFAULT_BASE64_ENCODE = true
+        DEFAULT_CONTENT_ID_DISABLE = true
+
+        attr_accessor :method
+        attr_accessor :mime_part_params
+
+        attr_reader :mime
+        attr_reader :account_id
+        attr_reader :extension_id
+
+        def initialize(opts = {})
+          @mime = MIME::Multipart::Mixed.new
+          @mime.headers.delete CONTENT_ID_HEADER
+
+          @method = opts[:method] ||= DEFAULT_METHOD
+
+          @mime_part_params = {
+            base64_encode: opts[:base64_encode] ||= DEFAULT_BASE64_ENCODE,
+            content_id_disable: opts[:content_id_disable] ||= DEFAULT_CONTENT_ID_DISABLE
+          }
+
+          path_params(opts)
+        end
+
+        def path_params(opts = {})
+          @account_id = opts[:account_id] ||= opts[:accountId] ||= DEFAULT_ID
+          @extension_id = opts[:extension_id] ||= opts[:extensionId] ||= DEFAULT_ID
+        end
+
+        def add_metadata(data, opts = {})
+          if data.is_a? MIME::Media
+            @mime.add data
+          else
+            @mime.add MIMEBuilder::JSON.new(
+              data,
+              @mime_part_params.merge(opts)
+            ).mime
+          end
+        end
+
+        def add_text(text = nil, opts = {})
+          return if text.nil? || text.to_s.empty?
+          @mime.add MIMEBuilder::Text.new(
+            text,
+            @mime_part_params.merge(opts)
+          ).mime
+        end
+
+        def add_file(file_path_or_part, opts = {})
+          if file_path_or_part.is_a? MIME::Media
+            @mime.add file_path_or_part
+          else
+            @mime.add MIMEBuilder::Filepath.new(
+              file_path_or_part,
+              @mime_part_params.merge(opts).merge({is_attachment: true})
+            ).mime
+          end
+        end
+
+        def add_files(files = [], opts = {})
+          files.each do |f|
+            add_file f, opts
+          end
+        end
+
+        def url
+          "account/#{@account_id}/extension/#{@extension_id}/sms"
+        end
+
+        def content_type
+          @mime.headers.get('Content-Type').to_s
+        end
+
+        def body
+          @mime.body.to_s
+        end
+      end
+    end
+  end
+end

data/lib/ringcentral_sdk/rest/request/fax.rb

@@ -1,111 +1,21 @@
-require 'base64'
-require 'mime'
-require 'mime/types'
-require 'mime_builder'
-require 'multi_json'
-
 module RingCentralSdk
   module REST
     module Request
-      # Helper to create a fax request
-      class Fax < RingCentralSdk::REST::Request::Base
-        attr_reader :msg
-
-        attr_reader :account_id
-        attr_reader :extension_id
-
-        def initialize(opts = {})
-          @metadata_part_encode_base64 = true
-
-          @msg = MIME::Multipart::Mixed.new
-          @msg.headers.delete('Content-Id')
-
-          add_path(opts)
-          add_part_meta(opts)
-          add_part_text(opts[:text])
-          add_parts(opts[:files])
-          add_parts(opts[:parts])
-        end
-
-        def add_path(opts = {})
-          @account_id = opts[:accountId] ||= '~'
-          @extension_id = opts[:extensionId] ||= '~'
-        end
-
-        def add_part_meta(opts = {})
-          meta = create_metadata opts
-          @msg.add MIMEBuilder::JSON.new(meta).mime
-          true
-        end
-
-        def create_metadata(opts = {})
-          meta = {}
-          return meta unless opts.is_a?(Hash)
-
-          inf = RingCentralSdk::REST::Request::Inflator::ContactInfo.new
-          meta[:to] = inf.inflate_to_array opts[:to]
-
-          processed = {
-            accountId: 1,
-            extensionId: 1,
-            to: 1,
-            text: 1,
-            files: 1,
-            parts: 1
-          }
-
-          opts.each do |k, v|
-            meta[k] = v unless processed.key? k
-          end
-
-          meta
-        end
-
-        def add_part_text(text = nil, opts = {})
-          return if text.nil? || text.to_s.empty?
-          opts[:content_id_disable] = true
-          text_part = MIMEBuilder::Text.new text, opts
-          @msg.add text_part.mime
-        end
-
-        def add_parts(parts = [])
-          return if parts.nil?
-          unless parts.is_a? Array
-            raise 'invalid parameter[0]. needs to be an array'
-          end
-          parts.each do |part|
-            if part.is_a? MIME::Media
-              @msg.add part
-            elsif part.is_a?(String)
-              file_part = MIMEBuilder::Filepath.new part
-              @msg.add file_part.mime
-            elsif part.is_a? Hash
-              part[:content_id_disable] = true
-              part[:is_attachment] = true
-              if part.key? :filename
-                @msg.add MIMEBuilder::Filepath.new(part[:filename], part).mime
-              elsif part.key? :text
-                @msg.add MIMEBuilder::Text.new(part[:text], part).mime
-              end
+      class Fax < RingCentralSdk::REST::Request::BaseMultipart
+        def add_metadata data, opts = {}
+          if data.is_a? Hash
+            inf = RingCentralSdk::REST::Request::Inflator::ContactInfo.new
+            if data.key? :to
+              data[:to] = inf.inflate_to_array data[:to]
             end
           end
-        end
 
-        def method
-          'post'
+          super data, opts
         end
 
         def url
           "account/#{@account_id}/extension/#{@extension_id}/fax"
         end
-
-        def content_type
-          @msg.headers.get('Content-Type').to_s
-        end
-
-        def body
-          @msg.body.to_s
-        end
       end
     end
   end

data/lib/ringcentral_sdk/rest/request/inflator/contact_info.rb

@@ -15,6 +15,16 @@ module RingCentralSdk
             end
             contacts
           end
+
+          def inflate_to_object(any = nil)
+            contact = {}
+            if any.is_a?(Hash)
+              contact = any
+            elsif any.is_a?(String) || any.is_a?(Integer)
+              contact = { phoneNumber: any }
+            end
+            contact
+          end
         end
       end
     end

data/lib/ringcentral_sdk/rest/request/sms.rb

@@ -0,0 +1,25 @@
+module RingCentralSdk
+  module REST
+    module Request
+      class SMS < RingCentralSdk::REST::Request::BaseMultipart
+        def add_metadata data, opts = {}
+          if data.is_a? Hash
+            inf = RingCentralSdk::REST::Request::Inflator::ContactInfo.new
+            if data.key? :to
+              data[:to] = inf.inflate_to_array data[:to]
+            end
+            if data.key? :from
+              data[:from] = inf.inflate_to_object data[:from]
+            end
+          end
+
+          super data, opts
+        end
+
+        def url
+          "account/#{@account_id}/extension/#{@extension_id}/sms"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ringcentral_sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2017-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -349,10 +349,12 @@ files:
 - lib/ringcentral_sdk/rest/messages_retriever.rb
 - lib/ringcentral_sdk/rest/request.rb
 - lib/ringcentral_sdk/rest/request/base.rb
+- lib/ringcentral_sdk/rest/request/base_multipart.rb
 - lib/ringcentral_sdk/rest/request/fax.rb
 - lib/ringcentral_sdk/rest/request/inflator.rb
 - lib/ringcentral_sdk/rest/request/inflator/contact_info.rb
 - lib/ringcentral_sdk/rest/request/simple.rb
+- lib/ringcentral_sdk/rest/request/sms.rb
 - lib/ringcentral_sdk/rest/simple_client.rb
 - lib/ringcentral_sdk/rest/subscription.rb
 - test/test_base.rb
@@ -384,7 +386,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: RingCentral SDK - Ruby SDK for the RingCentral Connect Platform API