mailinator_client 1.0.0 → 1.0.1

data/lib/mailinator_client/rules.rb

@@ -0,0 +1,221 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Manybrain, Inc.
+#
+# 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.
+
+require "json"
+
+module MailinatorClient
+
+  # Class containing all the actions for the Rules Resource
+  class Rules
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Creates a Rule. Note that in the examples, ":domain_id" can be one of your private domains.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    # *  {string} ruleToPost - The Rule object (https://manybrain.github.io/m8rdocs/#create-rule)
+    #
+    # Responses:
+    # *  Rule (https://manybrain.github.io/m8rdocs/#create-rule)
+    def create_rule(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+      raise ArgumentError.new("ruleToPost is required") unless params.has_key?(:ruleToPost)
+
+      body = params[:ruleToPost] if params.has_key?(:ruleToPost)
+
+      path = "/domains/#{params[:domainId]}/rules"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Enables an existing Rule
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    # *  {string} ruleId - The Rule id
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#enable-rule)
+    def enable_rule(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+      raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)
+
+      path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}/enable"
+
+      @client.request(
+        method: :put,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Disables an existing Rule
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    # *  {string} ruleId - The Rule id
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#disable-rule)
+    def disable_rule(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+      raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)
+
+      path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}/disable"
+
+      @client.request(
+        method: :put,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Fetches all Rules for a Domain.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    #
+    # Responses:
+    # *  Collection of rules (https://manybrain.github.io/m8rdocs/#get-all-rules)
+    def get_all_rules(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+
+      path = "/domains/#{params[:domainId]}/rules"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Fetches a specific rule for a Domain.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    # *  {string} ruleId - The Domain name or the Rule id
+    #
+    # Responses:
+    # *  Rule (https://manybrain.github.io/m8rdocs/#get-rule)
+    def get_rule(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+      raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)
+
+      path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Deletes a specific rule for a Domain.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    # *  {string} ruleId - The Rule id
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#delete-rule)
+    def delete_rule(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+      raise ArgumentError.new("rule id is required") unless params.has_key?(:ruleId)
+
+      path = "/domains/#{params[:domainId]}/rules/#{params[:ruleId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/mailinator_client/stats.rb

@@ -0,0 +1,82 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Manybrain, Inc.
+#
+# 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.
+
+require "json"
+
+module MailinatorClient
+
+  # Class containing all the actions for the Stats Resource
+  class Stats
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieves stats of team
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Collection of team stats (https://manybrain.github.io/m8rdocs/#get-all-domains)
+    def get_team_stats()
+      query_params = { }
+      headers = {}
+      body = nil
+
+      path = "/team/stats"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves team info
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Team info (https://manybrain.github.io/m8rdocs/#stats-api)
+    def get_team(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      path = "/team"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/mailinator_client/utils.rb

@@ -0,0 +1,44 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Manybrain, Inc.
+#
+# 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.
+
+module MailinatorClient
+  class Utils
+    def self.symbolize_hash_keys(hash)
+      Hash[hash.dup.map { |k, v| [k.to_sym, v] }]
+    end
+
+    def self.fix_query_arrays(value)
+      if value.respond_to?(:to_ary)
+        value = value.to_ary.map.with_index.to_a.to_h.invert
+      end
+
+      if value.respond_to?(:to_hash)
+        value = value.to_hash
+        value.each do |k, v|
+          value[k] = fix_query_arrays(v)
+        end
+      end
+
+      value
+    end
+  end
+end

data/lib/mailinator_client/version.rb

@@ -0,0 +1,25 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Manybrain, Inc.
+#
+# 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.
+
+module MailinatorClient
+  VERSION = "1.0.1"
+end

data/mailinator_client.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH.push(File.expand_path("../lib", __FILE__))
+require "mailinator_client/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "mailinator_client"
+  gem.authors       = ["Marian Melnychuk"]
+  gem.email         = ["marian.melnychuk@gmail.com"]
+  gem.summary       = %q{Provides a simple ruby wrapper around the Mailinator REST API}
+  gem.description   = %q{Easily use the Mailinator through its REST API with Ruby}
+  gem.homepage      = "https://github.com/manybrain/mailinator-ruby-client"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.version       = MailinatorClient::VERSION
+  gem.licenses      = ["MIT"]
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.add_dependency "httparty", "~> 0.14.0"
+
+  gem.add_development_dependency "minitest", "~> 5.9"
+  gem.add_development_dependency "rake", "~> 12"
+  gem.add_development_dependency "webmock", "~> 2.3"
+end

data/test/mailinator_client_api_test.rb

@@ -0,0 +1,132 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class MailinatorClientApiTest < MiniTest::Test
+
+  describe "test api functionality" do
+    before do
+      @auth_token = "MAILINATOR_TEST_API_TOKEN"
+      @inboxAll = "*"
+      @inbox = "MAILINATOR_TEST_INBOX"
+      @teamSMSNumber = "MAILINATOR_TEST_PHONE_NUMBER"
+      @messageIdWithAttachment = "MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID"
+      @attachmentId = "MAILINATOR_TEST_ATTACHMENT_ID"
+      @deleteDomain = "MAILINATOR_TEST_DELETE_DOMAIN"
+    end
+
+    it "should correctly do manipulation with mailinator data" do
+
+      client = MailinatorClient::Client.new(auth_token: @auth_token)
+
+      response = client.domains.get_domains
+      assert response != nil, "Expected get domains response to not be nil"
+      assert response["domains"] != nil, "Expected response domains to not be nil"
+      @domain = response["domains"][0]
+      @domainId = @domain["_id"]
+      @domainName = @domain["name"]
+      
+      response = client.domains.get_domain(domainId:@domainId)
+      assert response != nil, "Expected get domain response to not be nil"
+
+      ruleToPost = {
+        name:        "RuleName",
+        priority:    15,
+        description: "Description",
+        conditions: [
+          {
+            operation: "PREFIX",
+            condition_data: {
+              field: "to",
+              value: "raul"
+            }
+          }
+        ],
+        enabled: true,
+        match:   "ANY",
+        actions: [
+          {
+            action: "WEBHOOK",
+            action_data: {
+              url: "https://www.google.com"
+            }
+          }
+        ]
+      }
+
+      response = client.rules.create_rule(domainId:@domainId, ruleToPost: ruleToPost)
+      assert response != nil, "Expected get create rule response to not be nil"
+      assert response["_id"] != nil, "Expected response rule id to not be nil"
+
+      response = client.rules.get_all_rules(domainId:@domainId)
+      assert response != nil, "Expected get all rules response to not be nil"
+      assert response["rules"] != nil, "Expected response rules to not be nil"
+      @rule = response["rules"][0]
+      @ruleId = @rule["_id"]
+
+      response = client.rules.enable_rule(domainId:@domainId, ruleId: @ruleId)
+      assert response != nil, "Expected enable rule response to not be nil"
+      assert response["status"] == "ok", "Expected enable rule response to be ok"
+
+      response = client.rules.disable_rule(domainId:@domainId, ruleId: @ruleId)
+      assert response != nil, "Expected disable rule response to not be nil"
+      assert response["status"] == "ok", "Expected disable rule response to be ok"
+
+      response = client.rules.get_rule(domainId:@domainId, ruleId: @ruleId)
+      assert response != nil, "Expected disable rule response to not be nil"
+      assert response["_id"] != nil, "Expected get rule response to not be nil"
+
+      response = client.rules.delete_rule(domainId:@deleteDomain, ruleId: @ruleId)
+      assert response != nil, "Expected delete rule response to not be nil"
+      assert response["status"] == "ok", "Expected delete rule response to be ok"
+
+      response = client.messages.fetch_inbox(domain:@domainName, inbox: @inboxAll, skip: 0, limit: 50, sort: "ascending", decodeSubject: false)
+      assert response != nil, "Expected fetch inbox response to not be nil"
+      assert response["msgs"] != nil, "Expected response fetch inbox messages to not be nil"
+      @message = response["msgs"][0]
+      @messageId = @message["id"]
+
+      response = client.messages.fetch_message(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      assert response != nil, "Expected fetch message response to not be nil"
+
+      response = client.messages.fetch_sms_message(domain:@domainName, inbox: @inboxAll, teamSmsNumber: @teamSMSNumber)
+      assert response != nil, "Expected fetch sms message response to not be nil"
+
+      response = client.messages.fetch_attachments(domain:@domainName, inbox: @inbox, messageId: @messageIdWithAttachment)
+      assert response != nil, "Expected fetch attachments response to not be nil"
+
+      response = client.messages.fetch_attachment(domain:@domainName, inbox: @inbox, messageId: @messageIdWithAttachment, attachmentId: @attachmentId)
+      assert response != nil, "Expected fetch attachment response to not be nil"
+
+      response = client.messages.fetch_message_links(domain:@domainName, inbox: @inboxAll, messageId: @messageId)
+      assert response != nil, "Expected fetch message links response to not be nil"
+      assert response["links"] != nil, "Expected fetch message links links response to not be nil"
+
+      response = client.messages.delete_message(domain:@deleteDomain, inbox: @inbox, messageId: @messageId)
+      assert response != nil, "Expected delete message response to not be nil"
+      assert response["status"] == "ok", "Expected delete message response to be ok"
+
+      response = client.messages.delete_all_inbox_messages(domain:@deleteDomain, inbox: @inbox)
+      assert response != nil, "Expected delete all inbox messages response to not be nil"
+      assert response["status"] == "ok", "Expected delete all inbox messages response to be ok"
+
+      response = client.messages.delete_all_domain_messages(domain:@deleteDomain)
+      assert response != nil, "Expected delete all domain messages response to not be nil"
+      assert response["status"] == "ok", "Expected delete all domain messages response to be ok"
+
+      messageToPost = {
+        subject:"Testing ruby message",
+        from:"test_email_ruby@test.com", 
+        text:"I love Ruby!"
+      }
+      response = client.messages.inject_message(domain:@domainName, inbox: @inboxAll, messageToPost: messageToPost)
+      assert response != nil, "Expected inject message response to not be nil"
+      assert response["status"] == "ok", "Expected inject message response to be ok"
+
+      response = client.stats.get_team_stats
+      assert response != nil, "Expected response to not be nil"
+      assert response["stats"] != nil, "Expected response stats to not be nil"
+
+      response = client.stats.get_team
+      assert response != nil, "Expected response to not be nil"
+    end
+  end
+end