nexmo 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d795a930aa30a986720f2c457bcc4cd38d25bd0
-  data.tar.gz: dcdb8a13190059e0fd03839f4181cdeed6f368ad
+  metadata.gz: 706d683032b1928b5139d95e402e77497b0da9b2
+  data.tar.gz: f41681589bcc0a827b08fd521f80dbf2a52ee15c
 SHA512:
-  metadata.gz: 05fe7b23621f647f18f97afe4e56702ac75927d2a403c2ed82d94a5961f6a8eec2315404b1af0e4f9531316a21317a50c290652e571ea74eceb8b9ebbada65a1
-  data.tar.gz: 698907b35b947e52e4a380ac8988449886891a8c3dee1da785fae29d6c6d2cff410fcf2b9d25f54a04e9f6b4ae45af8bbbd528ad4024ec73534dec992f0f26a5
+  metadata.gz: ec1f6d2a5d131f4174407276992e54b00ddc99c87081d277a67c798cc8b4e2ac737c1c5b248deee1d697357409d241a469a9ca9c6fbf8a7b2695ea94f6bca6ad
+  data.tar.gz: d057d84301e06e758b389724d3526cba8c34986118c40fbc4e14ea302bf15bf00542947941298f9361c1e205f146803a469ce59c6653fabf00ee32938a2919ef

data/README.md

@@ -1,21 +1,53 @@
-nexmo
-=====
+Nexmo Client Library for Ruby
+=============================
 
+[Installation](#installation) | [Usage](#usage) | [Examples](#examples) | [License](#license)
 
-Ruby client for the [Nexmo API](https://docs.nexmo.com/).
+This is the Ruby client library for Nexmo's API. To use it you'll
+need a Nexmo account. Sign up [for free at nexmo.com][signup].
 
 
 Installation
 ------------
 
+To install the Ruby client library using Rubygems:
+
     $ gem install nexmo
 
+Alternatively you can clone the repo or download the source.
+
+
+Usage
+-----
+
+Specify your credentials using the `NEXMO_API_KEY` and `NEXMO_API_SECRET`
+environment variables; require the nexmo library; and construct a client object.
+For example:
+
+```ruby
+require 'nexmo'
+
+nexmo = Nexmo::Client.new
+```
+
+Alternatively you can specify your credentials directly using the `key`
+and `secret` options:
+
+```ruby
+require 'nexmo'
+
+nexmo = Nexmo::Client.new(key: 'YOUR-API-KEY', secret: 'YOUR-API-SECRET')
+```
+
+
+Examples
+--------
+
+### Sending A Message
 
-Sending a message
------------------
+Use [Nexmo's SMS API][doc_sms] to send an SMS message. 
 
-Construct a Nexmo::Client object with your API credentials and call
-the #send_message method. For example:
+Call the send_message method with a hash containing the message parameters. For example:
 
 ```ruby
 require 'nexmo'
@@ -31,18 +63,12 @@ else
 end
 ```
 
-The Nexmo documentation contains a [list of response codes](https://docs.nexmo.com/api-ref/sms-api/response/status-codes)
-which may be useful for debugging errors. Remember that phone numbers
-should be specified in international format, and other country specific
-restrictions may apply (e.g. US messages must originate from either a
-pre-approved long number or short code).
 
+License
+-------
 
-Production environment variables
---------------------------------
+This library is released under the [MIT License][license]
 
-Best practice for storing credentials for external services in production is
-to use environment variables, as described by [12factor.net/config](http://12factor.net/config).
-Nexmo::Client defaults to extracting the api key/secret it needs from the
-NEXMO_API_KEY and NEXMO_API_SECRET environment variables if the key/secret
-options were not specified explicitly.
+[signup]: http://nexmo.com?src=ruby-client-library
+[doc_sms]: https://docs.nexmo.com/messaging/sms-api
+[license]: LICENSE.txt

data/lib/nexmo.rb

@@ -21,144 +21,154 @@ module Nexmo
       @secret = options.fetch(:secret) { ENV.fetch('NEXMO_API_SECRET') }
 
       @host = options.fetch(:host) { 'rest.nexmo.com' }
+
+      @api_host = options.fetch(:api_host) { 'api.nexmo.com' }
     end
 
     def send_message(params)
-      post('/sms/json', params)
+      post("https://#@host/sms/json", params)
     end
 
     def get_balance
-      get('/account/get-balance')
+      get("https://#@host/account/get-balance")
     end
 
     def get_country_pricing(country_code)
-      get('/account/get-pricing/outbound', country: country_code)
+      get("https://#@host/account/get-pricing/outbound", country: country_code)
     end
 
     def get_prefix_pricing(prefix)
-      get('/account/get-prefix-pricing/outbound', prefix: prefix)
+      get("https://#@host/account/get-prefix-pricing/outbound", prefix: prefix)
+    end
+
+    def update_settings(params)
+      post("https://#@host/account/settings", params)
+    end
+
+    def topup(params)
+      post("https://#@host/account/top-up", params)
     end
 
     def get_account_numbers(params)
-      get('/account/numbers', params)
+      get("https://#@host/account/numbers", params)
     end
 
     def get_available_numbers(country_code, params = {})
-      get('/number/search', {country: country_code}.merge(params))
+      get("https://#@host/number/search", {country: country_code}.merge(params))
     end
 
     def buy_number(params)
-      post('/number/buy', params)
+      post("https://#@host/number/buy", params)
     end
 
     def cancel_number(params)
-      post('/number/cancel', params)
+      post("https://#@host/number/cancel", params)
     end
 
     def update_number(params)
-      post('/number/update', params)
+      post("https://#@host/number/update", params)
     end
 
     def get_message(id)
-      get('/search/message', id: id)
+      get("https://#@host/search/message", id: id)
     end
 
     def get_message_rejections(params)
-      get('/search/rejections', params)
+      get("https://#@host/search/rejections", params)
     end
 
     def search_messages(params)
-      get('/search/messages', Hash === params ? params : {ids: Array(params)})
+      get("https://#@host/search/messages", Hash === params ? params : {ids: Array(params)})
     end
 
     def send_ussd_push_message(params)
-      post('/ussd/json', params)
+      post("https://#@host/ussd/json", params)
     end
 
     def send_ussd_prompt_message(params)
-      post('/ussd-prompt/json', params)
+      post("https://#@host/ussd-prompt/json", params)
     end
 
     def send_2fa_message(params)
-      post('/sc/us/2fa/json', params)
+      post("https://#@host/sc/us/2fa/json", params)
     end
 
     def send_event_alert_message(params)
-      post('/sc/us/alert/json', params)
+      post("https://#@host/sc/us/alert/json", params)
     end
 
     def send_marketing_message(params)
-      post('/sc/us/marketing/json', params)
+      post("https://#@host/sc/us/marketing/json", params)
     end
 
     def initiate_call(params)
-      post('/call/json', params)
+      post("https://#@host/call/json", params)
     end
 
     def initiate_tts_call(params)
-      post('https://api.nexmo.com/tts/json', params)
+      post("https://#@api_host/tts/json", params)
     end
 
     def initiate_tts_prompt_call(params)
-      post('https://api.nexmo.com/tts-prompt/json', params)
+      post("https://#@api_host/tts-prompt/json", params)
     end
 
     def send_verification_request(params)
-      post('https://api.nexmo.com/verify/json', params)
+      post("https://#@api_host/verify/json", params)
     end
 
     def check_verification_request(params)
-      post('https://api.nexmo.com/verify/check/json', params)
+      post("https://#@api_host/verify/check/json", params)
     end
 
     def get_verification_request(id)
-      get('https://api.nexmo.com/verify/search/json', request_id: id)
+      get("https://#@api_host/verify/search/json", request_id: id)
     end
 
     def control_verification_request(params)
-      post('https://api.nexmo.com/verify/control/json', params)
+      post("https://#@api_host/verify/control/json", params)
     end
 
     def get_basic_number_insight(params)
-      get('https://api.nexmo.com/number/format/json', params)
+      get("https://#@api_host/number/format/json", params)
     end
 
     def get_number_insight(params)
-      get('https://api.nexmo.com/number/lookup/json', params)
+      get("https://#@api_host/number/lookup/json", params)
     end
 
     def request_number_insight(params)
-      post('/ni/json', params)
+      post("https://#@host/ni/json", params)
     end
 
     private
 
     USER_AGENT = "ruby-nexmo/#{VERSION}/#{RUBY_VERSION}"
 
-    def get(path, params = {})
-      uri = URI.join("https://#{@host}", path)
+    def get(uri, params = {})
+      uri = URI(uri)
       uri.query = query_string(params.merge(api_key: @key, api_secret: @secret))
 
-      get_request = Net::HTTP::Get.new(uri.request_uri)
-      get_request['User-Agent'] = USER_AGENT
+      message = Net::HTTP::Get.new(uri.request_uri)
+      message['User-Agent'] = USER_AGENT
 
-      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
-      http.use_ssl = true
-
-      parse http.request(get_request), uri.host
+      parse(request(uri, message), uri.host)
     end
 
-    def post(path, params)
-      uri = URI.join("https://#{@host}", path)
+    def post(uri, params)
+      uri = URI(uri)
 
-      post_request = Net::HTTP::Post.new(uri.request_uri)
-      post_request.form_data = params.merge(api_key: @key, api_secret: @secret)
-      post_request['User-Agent'] = USER_AGENT
+      message = Net::HTTP::Post.new(uri.request_uri)
+      message.form_data = params.merge(api_key: @key, api_secret: @secret)
+      message['User-Agent'] = USER_AGENT
 
+      parse(request(uri, message), uri.host)
+    end
+
+    def request(uri, message)
       http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
       http.use_ssl = true
-
-      parse http.request(post_request), uri.host
+      http.request(message)
     end
 
     def parse(http_response, host)

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/nexmo.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'http://github.com/Nexmo/nexmo'
-  s.description = 'Ruby client for the Nexmo API'
-  s.summary = 'See description'
+  s.homepage = 'https://github.com/Nexmo/nexmo-ruby'
+  s.description = 'Nexmo Client Library for Ruby'
+  s.summary = 'This is the Ruby client library for Nexmo\'s API. To use it you\'ll need a Nexmo account. Sign up for free at https://www.nexmo.com'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md nexmo.gemspec)
   s.required_ruby_version = '>= 1.9.3'
   s.add_development_dependency('rake', '~> 10.1')

data/spec/nexmo_spec.rb

@@ -63,6 +63,26 @@ describe 'Nexmo::Client' do
     end
   end
 
+  describe 'update_settings method' do
+    it 'updates the account settings resource with the given parameters and returns the response object' do
+      url = "#@base_url/account/settings"
+
+      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+
+      @client.update_settings(moCallBackUrl: 'http://example.com/callback').must_equal(@json_response_object)
+    end
+  end
+
+  describe 'topup method' do
+    it 'updates the account top-up resource with the given parameters and returns the response object' do
+      url = "#@base_url/account/top-up"
+
+      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+
+      @client.topup(trx: '00X123456Y7890123Z').must_equal(@json_response_object)
+    end
+  end
+
   describe 'get_account_numbers method' do
     it 'fetches the account numbers resource with the given parameters and returns the response object' do
       url = "#@base_url/account/numbers?api_key=key&api_secret=secret&size=25&pattern=33"
@@ -328,4 +348,16 @@ describe 'Nexmo::Client' do
 
     assert_requested(request)
   end
+
+  it 'provides an option for specifying a different api hostname to connect to' do
+    url = "https://debug.example.com/number/format/json?api_key=key&api_secret=secret&number=447525856424"
+
+    request = stub_request(:get, url).to_return(@json_response_body)
+
+    @client = Nexmo::Client.new(key: 'key', secret: 'secret', api_host: 'debug.example.com')
+
+    @client.get_basic_number_insight(number: '447525856424')
+
+    assert_requested(request)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Ruby client for the Nexmo API
+description: Nexmo Client Library for Ruby
 email:
 - mail@timcraft.com
 executables: []
@@ -65,7 +65,7 @@ files:
 - lib/nexmo/version.rb
 - nexmo.gemspec
 - spec/nexmo_spec.rb
-homepage: http://github.com/Nexmo/nexmo
+homepage: https://github.com/Nexmo/nexmo-ruby
 licenses:
 - MIT
 metadata: {}
@@ -85,8 +85,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: See description
+summary: This is the Ruby client library for Nexmo's API. To use it you'll need a
+  Nexmo account. Sign up for free at https://www.nexmo.com
 test_files: []