messagemedia_lookups_sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 954fac8750860e9ede7c813fea25cfc3455be9d0
-  data.tar.gz: 1e0e24d4d9bc1eb88bb5e41e3c40480a32f3c71c
+SHA256:
+  metadata.gz: a17f807e557fb990af27aaec864c128cb449293b0b735940947ad528c4b1840f
+  data.tar.gz: '034387f95f95045ab1bfcee4e69dcc500828d2e4d51dafaaecacf4512063d8b7'
 SHA512:
-  metadata.gz: 8b20a90b64529e58f8165dd73b40ad1a558ef3834e939d76379b6605f8e0f67e9e5477800719d7873589b9da4dde67829a53deaaeca170bc7e5c86a75aea30b3
-  data.tar.gz: 9246ef950421e9356b331a98b347fcd4b67baa469d7cc6720bdae406629682285831b32a899ba399743b60cbf1bbaa18e8e737f0e2678287f0357d6f11906c4c
+  metadata.gz: 99f7306b445d6e598de46bcaefc28e27b0911c5d6ab6ec2d8e1367d5135c743a70d2ab83c4f11532c763d4fd14c8764d865bfca6d0ccdd66898db309ee8b5d51
+  data.tar.gz: 3c665abfa7807666ad3c4be7b3ff9602cf3f62e6c5ad8b2cc89b90ea26d2e3224913bbfceb9ad233494e9e784c53f2d6503273c376141dc31a582729360ad6dc

data/README.md

@@ -1,42 +1,102 @@
-# MessageMedia Lookups Ruby SDK
-[![Build Status](https://travis-ci.org/messagemedia/lookups-ruby-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/lookups-ruby-sdk)
-[![gem](https://img.shields.io/badge/gem-v1.1.0-red.svg)](https://rubygems.org/gems/messagemedia_lookups)
-
-The MessageMedia Lookups API provides a number of endpoints for validating the phone numbers you’re sending to by checking their validity, type and carrier records.
-
-## ⭐️ Installing via RubyGems
-* Run the following command to install the SDK via RubyGems: 
-```gem install messagemedia_lookups```
-
-## 🎬 Get Started
-It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below and a mobile number you wish to send to.
-
-### 👀 Lookup a number
-```ruby
-require 'message_media_lookups'
-
-# Configuration parameters and credentials
-auth_user_name = 'YOUR_API_KEY' # The username to use with basic/HMAC authentication
-auth_password = 'YOUR_SECRET_KEY' # The password to use with basic/HMAC authentication
-use_hmac = false # Change this to true if you are using HMAC keys
-
-client = MessageMediaLookups::MessageMediaLookupsClient.new(
-  auth_user_name: auth_user_name,
-  auth_password: auth_password,
-  use_hmac: use_hmac
-)
-
-lookups_controller = client.lookups
-
-phone_number = 'YOUR_MOBILE_NUMBER'
-options = 'carrier,type'
-
-result = lookups_controller.get_lookup_a_phone_number(phone_number, options)
-print result.inspect
-```
-
-## 📕 Documentation
-The Ruby SDK Documentation can be viewed [here](DOCUMENTATION.md)
-
-## 😕 Need help?
-Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
+# MessageMedia Lookups Ruby SDK
+[![Build Status](https://travis-ci.org/messagemedia/lookups-ruby-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/lookups-ruby-sdk)
+[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
+[![Gem Version](https://badge.fury.io/rb/messagemedia_lookups_sdk.svg)](https://badge.fury.io/rb/messagemedia_lookups_sdk)
+
+The MessageMedia Lookups API provides a number of endpoints for validating the phone numbers you’re sending to by checking their validity, type and carrier records.
+
+![Isometric](https://developers.messagemedia.com/wp-content/uploads/2017/11/lookups-api.png)
+
+## Table of Contents
+* [Authentication](#closed_lock_with_key-authentication)
+* [Errors](#interrobang-errors)
+* [Information](#newspaper-information)
+  * [Slack and Mailing List](#slack-and-mailing-list)
+  * [Bug Reports](#bug-reports)
+  * [Contributing](#contributing)
+* [Installation](#star-installation)
+* [Get Started](#clapper-get-started)
+* [API Documentation](#closed_book-api-documentation)
+* [Need help?](#confused-need-help)
+* [License](#page_with_curl-license)
+
+## :closed_lock_with_key: Authentication
+
+Authentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.
+
+Requests are authenticated using HTTP Basic Auth or HMAC. Provide your API key as the auth_user_name and API secret as the auth_password.
+
+## :interrobang: Errors
+
+Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON. The most common status codes are listed below.
+
+#### HTTP Status Codes
+
+| Code      | Title       | Description |
+|-----------|-------------|-------------|
+| 400 | Invalid Request | The request was invalid |
+| 401 | Unauthorized | Your API credentials are invalid |
+| 403 | Disabled feature | Feature not enabled |
+| 404 | Not Found |	The resource does not exist |
+| 50X | Internal Server Error | An error occurred with our API |
+
+## :newspaper: Information
+
+#### Slack and Mailing List
+
+If you have any questions, comments, or concerns, please join our Slack channel:
+https://developers.messagemedia.com/collaborate/slack/
+
+Alternatively you can email us at:
+developers@messagemedia.com
+
+#### Bug reports
+
+If you discover a problem with the SDK, we would like to know about it. You can raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues) or send an email to: developers@messagemedia.com
+
+#### Contributing
+
+We welcome your thoughts on how we could best provide you with SDKs that would simplify how you consume our services in your application. You can fork and create pull requests for any features you would like to see or raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues)
+
+
+## :star: Installation
+Run the following command to install the SDK via RubyGems: 
+```
+gem install messagemedia_lookups
+```
+
+## :clapper: Get Started
+It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below and a mobile number you wish to send to.
+
+### Lookup a number
+```ruby
+require 'message_media_lookups'
+
+# Configuration parameters and credentials
+auth_user_name = 'YOUR_API_KEY' # The username to use with basic/HMAC authentication
+auth_password = 'YOUR_SECRET_KEY' # The password to use with basic/HMAC authentication
+use_hmac = false # Change this to true if you are using HMAC keys
+
+client = MessageMediaLookups::MessageMediaLookupsClient.new(
+  auth_user_name: auth_user_name,
+  auth_password: auth_password,
+  use_hmac: use_hmac
+)
+
+lookups_controller = client.lookups
+
+phone_number = 'YOUR_MOBILE_NUMBER'
+options = 'carrier,type'
+
+result = lookups_controller.get_lookup_a_phone_number(phone_number, options)
+print result.inspect
+```
+
+## :closed_book: API Reference Documentation
+Check out the [full API documentation](https://developers.messagemedia.com/code/lookups-api-documentation/) for more detailed information.
+
+## :confused: Need help?
+Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
+
+## :page_with_curl: License
+Apache License. See the [LICENSE](LICENSE) file.

data/lib/message_media_lookups/http/auth/hmac_auth.rb

@@ -1,52 +1,52 @@
-
-require 'base64'
-
-module MessageMediaMessages
-  # Utility class for basic authorization.
-  class HmacAuth
-    def self.create_signature(date, content_signature, url, body=nil)
-      request_type = "GET"
-
-      if body != nil
-        request_type = "POST"
-      end
-
-      signing_string = "date: #{date}\n#{content_signature}#{request_type} #{url} HTTP/1.1"
-      hmac = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), Configuration.hmac_auth_password.encode("ASCII"), signing_string.encode("ASCII"))
-
-      return Base64.encode64(hmac).chomp
-    end
-
-    # Add basic authentication to the request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will
-    # be added.
-    def self.apply(http_request, url=nil, body=nil)
-      username = Configuration.hmac_auth_user_name
-
-      content_signature = ""
-      content_header = ""
-
-      now = DateTime.now.new_offset(0).to_time.strftime("%a, %d %b %Y %H:%M:%S GMT")
-
-      date_header = now
-
-      if body != nil
-        md5 = Digest::MD5.new
-        md5.update(body)
-
-        content_hash = md5.hexdigest
-        content_signature = "x-Content-MD5: #{content_hash}\n"
-        content_header = "x-Content-MD5 "
-        http_request.headers["x-Content-MD5"] = content_hash
-      end
-
-      http_request.headers["date"] = date_header
-
-      hmac_signature = HmacAuth.create_signature(date_header, content_signature, url, body)
-
-      joined = "username=\"#{username}\", algorithm=\"hmac-sha1\", headers=\"date #{content_header}request-line\", signature=\"#{hmac_signature}\""
-      header_value = "hmac #{joined}"
-      http_request.headers["Authorization"] = header_value
-    end
-  end
-end
+
+require 'base64'
+
+module MessageMediaMessages
+  # Utility class for basic authorization.
+  class HmacAuth
+    def self.create_signature(date, content_signature, url, body=nil)
+      request_type = "GET"
+
+      if body != nil
+        request_type = "POST"
+      end
+
+      signing_string = "date: #{date}\n#{content_signature}#{request_type} #{url} HTTP/1.1"
+      hmac = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), Configuration.hmac_auth_password.encode("ASCII"), signing_string.encode("ASCII"))
+
+      return Base64.encode64(hmac).chomp
+    end
+
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(http_request, url=nil, body=nil)
+      username = Configuration.hmac_auth_user_name
+
+      content_signature = ""
+      content_header = ""
+
+      now = DateTime.now.new_offset(0).to_time.strftime("%a, %d %b %Y %H:%M:%S GMT")
+
+      date_header = now
+
+      if body != nil
+        md5 = Digest::MD5.new
+        md5.update(body)
+
+        content_hash = md5.hexdigest
+        content_signature = "x-Content-MD5: #{content_hash}\n"
+        content_header = "x-Content-MD5 "
+        http_request.headers["x-Content-MD5"] = content_hash
+      end
+
+      http_request.headers["date"] = date_header
+
+      hmac_signature = HmacAuth.create_signature(date_header, content_signature, url, body)
+
+      joined = "username=\"#{username}\", algorithm=\"hmac-sha1\", headers=\"date #{content_header}request-line\", signature=\"#{hmac_signature}\""
+      header_value = "hmac #{joined}"
+      http_request.headers["Authorization"] = header_value
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagemedia_lookups_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - MessageMedia Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -28,16 +28,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: MessageMedia Lookups SDK