omnichannel 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+=begin
+#Omnichannel API
+
+#Messente's API which allows sending messages via various channels with fallback options.
+
+OpenAPI spec version: 0.0.2
+Contact: messente@messente.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+# load the gem
+require 'openapi_client'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/templates/README.mustache

@@ -0,0 +1,114 @@
+# {{gemName}}
+
+{{moduleName}} - the Ruby gem for the {{appName}}
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build {{{gemName}}}.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
+```
+(for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.gem` to install the development dependencies)
+
+Finally add this to the Gemfile:
+
+    gem '{{{gemName}}}', '~> {{{gemVersion}}}'
+
+### Install from Git
+
+    gem '{{{gemName}}}', :git => 'https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}.git'
+
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+require 'omnichannel'
+# setup authorization
+Omnichannel.configure do |config|
+    # Configure HTTP basic authorization: basicAuth
+    config.username = '<MESSENTE_API_USERNAME>'
+    config.password = '<MESSENTE_API_PASSWORD>'
+end
+
+api_instance = Omnichannel::OmnimessageApi.new
+omnimessage = Omnichannel::Omnimessage.new
+omnimessage.to = '<phone number in e.164 format>'
+omnimessage.messages = [
+    Omnichannel::SMS.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => "Hello SMS!"
+        }
+    ),
+    Omnichannel::WhatsApp.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => Omnichannel::WhatsAppText.new(
+                {
+                    :body => "Hello from WhatsApp!",
+                    :preview_url => false
+                }
+            )
+        }
+    ),
+    Omnichannel::Viber.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => "Hello from Viber!"
+        }
+    )
+]
+
+begin
+    result = api_instance.send_omnimessage(omnimessage)
+rescue Omnichannel::ApiError => e
+    puts "Exception when calling OmnimessageApi->send_omnimessage: #{e}"
+    puts e.response_body
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *{{basePath}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+## Documentation for Models
+
+{{#models}}{{#model}} - [{{moduleName}}::{{classname}}]({{modelDocPath}}{{classname}}.md)
+{{/model}}{{/models}}
+
+## Documentation for Authorization
+
+{{^authMethods}} All endpoints do not require authorization.
+{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
+{{#authMethods}}### {{name}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{keyParamName}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}- **Type**: HTTP basic authentication
+{{/isBasic}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}}  - {{scope}}: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}

metadata

@@ -0,0 +1,358 @@
+--- !ruby/object:Gem::Specification
+name: omnichannel
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Messente
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+- !ruby/object:Gem::Dependency
+  name: autotest-rails-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: autotest-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+description: This libraries allows sending messages to various channels such as WhatsApp,
+  Viber and SMS with fallback to backup channels in case of failure.
+email:
+- messente@messente.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config.json
+- docs/Channel.md
+- docs/DeliveryReportApi.md
+- docs/DeliveryReportResponse.md
+- docs/DeliveryResult.md
+- docs/Err.md
+- docs/ErrorItem.md
+- docs/ErrorResponse.md
+- docs/Message.md
+- docs/MessageResult.md
+- docs/OmniMessageCreateSuccessResponse.md
+- docs/Omnimessage.md
+- docs/OmnimessageApi.md
+- docs/ResponseErrorCode.md
+- docs/ResponseErrorTitle.md
+- docs/SMS.md
+- docs/Status.md
+- docs/Viber.md
+- docs/WhatsApp.md
+- docs/WhatsAppAudio.md
+- docs/WhatsAppDocument.md
+- docs/WhatsAppImage.md
+- docs/WhatsAppText.md
+- git_push.sh
+- lib/omnichannel.rb
+- lib/omnichannel/api/delivery_report_api.rb
+- lib/omnichannel/api/omnimessage_api.rb
+- lib/omnichannel/api_client.rb
+- lib/omnichannel/api_error.rb
+- lib/omnichannel/configuration.rb
+- lib/omnichannel/models/channel.rb
+- lib/omnichannel/models/delivery_report_response.rb
+- lib/omnichannel/models/delivery_result.rb
+- lib/omnichannel/models/err.rb
+- lib/omnichannel/models/error_item.rb
+- lib/omnichannel/models/error_response.rb
+- lib/omnichannel/models/message.rb
+- lib/omnichannel/models/message_result.rb
+- lib/omnichannel/models/omni_message_create_success_response.rb
+- lib/omnichannel/models/omnimessage.rb
+- lib/omnichannel/models/response_error_code.rb
+- lib/omnichannel/models/response_error_title.rb
+- lib/omnichannel/models/sms.rb
+- lib/omnichannel/models/status.rb
+- lib/omnichannel/models/viber.rb
+- lib/omnichannel/models/whats_app.rb
+- lib/omnichannel/models/whats_app_audio.rb
+- lib/omnichannel/models/whats_app_document.rb
+- lib/omnichannel/models/whats_app_image.rb
+- lib/omnichannel/models/whats_app_text.rb
+- lib/omnichannel/version.rb
+- lib/openapi_client.rb
+- lib/openapi_client/api/delivery_report_api.rb
+- lib/openapi_client/api/omnimessage_api.rb
+- lib/openapi_client/api_client.rb
+- lib/openapi_client/api_error.rb
+- lib/openapi_client/configuration.rb
+- lib/openapi_client/models/channel.rb
+- lib/openapi_client/models/delivery_report_response.rb
+- lib/openapi_client/models/delivery_result.rb
+- lib/openapi_client/models/err.rb
+- lib/openapi_client/models/error_item.rb
+- lib/openapi_client/models/error_response.rb
+- lib/openapi_client/models/message.rb
+- lib/openapi_client/models/message_result.rb
+- lib/openapi_client/models/omni_message_create_success_response.rb
+- lib/openapi_client/models/omnimessage.rb
+- lib/openapi_client/models/response_error_code.rb
+- lib/openapi_client/models/response_error_title.rb
+- lib/openapi_client/models/sms.rb
+- lib/openapi_client/models/status.rb
+- lib/openapi_client/models/viber.rb
+- lib/openapi_client/models/whats_app.rb
+- lib/openapi_client/models/whats_app_audio.rb
+- lib/openapi_client/models/whats_app_document.rb
+- lib/openapi_client/models/whats_app_image.rb
+- lib/openapi_client/models/whats_app_text.rb
+- lib/openapi_client/version.rb
+- omnichannel.gemspec
+- spec/api/delivery_report_api_spec.rb
+- spec/api/omnimessage_api_spec.rb
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/models/channel_spec.rb
+- spec/models/delivery_report_response_spec.rb
+- spec/models/delivery_result_spec.rb
+- spec/models/err_spec.rb
+- spec/models/error_item_spec.rb
+- spec/models/error_response_spec.rb
+- spec/models/message_result_spec.rb
+- spec/models/message_spec.rb
+- spec/models/omni_message_create_success_response_spec.rb
+- spec/models/omnimessage_spec.rb
+- spec/models/response_error_code_spec.rb
+- spec/models/response_error_title_spec.rb
+- spec/models/sms_spec.rb
+- spec/models/status_spec.rb
+- spec/models/viber_spec.rb
+- spec/models/whats_app_audio_spec.rb
+- spec/models/whats_app_document_spec.rb
+- spec/models/whats_app_image_spec.rb
+- spec/models/whats_app_spec.rb
+- spec/models/whats_app_text_spec.rb
+- spec/spec_helper.rb
+- templates/README.mustache
+homepage: https://openapi-generator.tech
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby library for Messente Omnichannel API
+test_files:
+- spec/api/delivery_report_api_spec.rb
+- spec/api/omnimessage_api_spec.rb
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/models/whats_app_spec.rb
+- spec/models/omnimessage_spec.rb
+- spec/models/sms_spec.rb
+- spec/models/whats_app_audio_spec.rb
+- spec/models/message_result_spec.rb
+- spec/models/whats_app_image_spec.rb
+- spec/models/channel_spec.rb
+- spec/models/response_error_code_spec.rb
+- spec/models/response_error_title_spec.rb
+- spec/models/status_spec.rb
+- spec/models/viber_spec.rb
+- spec/models/whats_app_document_spec.rb
+- spec/models/whats_app_text_spec.rb
+- spec/models/message_spec.rb
+- spec/models/omni_message_create_success_response_spec.rb
+- spec/models/error_response_spec.rb
+- spec/models/error_item_spec.rb
+- spec/models/err_spec.rb
+- spec/models/delivery_result_spec.rb
+- spec/models/delivery_report_response_spec.rb
+- spec/spec_helper.rb