unione-ruby 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8462ee8f317ff0d316298a45e0f6f948897776346bcbe7f70997190a681e02a
-  data.tar.gz: 51f9b320c81f7bd65559b10eda50bdaf20a0bd1148c2d7017590a1d344319118
+  metadata.gz: d8807a2fc79452659177a7447867e38ca650482c9bd691a6c701a20d7c115f20
+  data.tar.gz: 9ecb1e6785c72f73d465c5469d754bbd93f41de4a64ecd8e6c042690886638fc
 SHA512:
-  metadata.gz: 46993c14f31096f8f22eefb96f050c26436088335ef44572d981fd599f25187b333d69b7c19790e0fe04f3efee05b164f226181d5633f0c06c30737a25e62bd4
-  data.tar.gz: 33b4d179be489d1edb42b0a24f5866a672d640ae90e30dd8db1376a63ecb695624c5034b48f52b30584153c1298cf7fd780be610204ae7e02e43715d3e37e82f
+  metadata.gz: 95b0951bef570f71a7481ec8e6f9460e57ff827c3fe3b9083645ed28ab71904bfbdde6f83f853008f0a7ce1707fe62b6dfb47fb941ac36f008eb98c63e72e92c
+  data.tar.gz: 3cc19ac8f9641a6849a59f4fab4b7c72e5585f10928831ff0f41da3d24ddc38aa24d764183008e5fc6184d619a52d8bbeb544a9abae16afc97cdb56301ace9a7

data/README.md

@@ -1,42 +1,133 @@
 # unione-ruby
+
 UniOne (unione.io) integration gem for Ruby
 
 [Examples of usage](https://github.com/unione-repo/unione-ruby/tree/master/examples)
 
+## Installation
+
+    gem install unione-ruby
+
 ## Working with API responses
+
 This library using [faraday](https://github.com/lostisland/faraday) gem for making HTTP queries along with [mashify middleware](https://github.com/hashie/hashie#mash) for post-processing response body. So, you can use extended syntax for accessing response fields.
 
 Example of work with responses:
 
-```ruby
+~~~ruby
 require 'unione-ruby'
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_API_KEY']
+)
+
 response = unione.get_dns_records("example.com")
+
 puts response.status
 puts response.body.to_h
 puts response.headers
-# Access fields as hash or as methods
+
+# Access fields as hash keys or as object attributes:
 puts response.body['status']
 puts response.body.status
-```
+~~~
+
+## Passing API key in parameters
+
+By default authentication sent through X-API-KEY header.
+
+For passing API key in parameters, use:
+
+~~~ruby
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_API_KEY'],
+  api_key_in_params: true
+)
+~~~
+
+## Verify webhook callback message
+
+Will raise Unione::Client::InvalidCallbackAuth error unless `auth' field is correct.
+
+~~~ruby
+unione.verify_callback_auth!(params)
+~~~
+
+## Webhook callback helper
+
+Use it to substitute webhook handler verification and parsing to
+directly get list of events.
+
+Will raise Unione::Client::InvalidCallbackAuth error unless `auth' field is correct.
+
+~~~ruby
+unione.callback_helper(params) do |events|
+  # [
+  #   {
+  #     'event_name' => 'transactional_email_status',
+  #     'event_data' =>
+  #      {
+  #        'email' => 'recipient.email@example.com',
+  #        'status' => 'sent',
+  #        'event_time' => '2015-11-30 15:09:42',
+  #       ...
+  #      }
+  #   },
+  #   ...
+  # ]
+end
+~~~
 
 ## Handling API errors
+
 Library using [`raise-error' middleware](https://lostisland.github.io/faraday/middleware/raise-error) for handling error responses.
 
 Example of work with errors:
 
-```ruby
+~~~ruby
 require 'unione-ruby'
+
 begin
-  unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+  unione = UniOne::Client.new(
+    hostname: 'eu1.unione.io',
+    lang: 'en',
+    api_key: ENV['UNIONE_API_KEY']
+  )
+
   response = unione.get_dns_records("example.com")
+
   puts response.status
   puts response.body.to_h
   puts response.headers
+
 rescue Faraday::Error => e
-  # Note that exception response has internal format which is a little bit different and body field is not post-processed
+
+  # Note that exception response has internal format which is a little
+  # bit different and body field is not post-processed
+
   puts e.response[:status]
   puts e.response[:body]
   puts e.response[:headers]
+
 end
-```
+~~~
+
+## HTTP timeout configuration
+
+Pass `timeout: <seconds>` parameter on creating client, default is 5.
+
+## HTTP logging
+
+Pass `enable_logging: true` parameter on creating client to enable logging, default false.
+
+## Testing
+
+You can run tests through included test task and passing methods for
+test and data inside YAML config file:
+
+    rake test DOMAIN APIKEY WEBHOOK_URL FROM_EMAIL ./test/CONFIGFILE.yml

data/Rakefile

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'unione-ruby'
+require 'yaml'
+
+task :console do
+  exec "irb -r unione-ruby -I ./lib"
+end
+
+task :test do
+  unione = UniOne::Client.new(
+    hostname: ARGV[1],
+    lang: 'en',
+    api_key: ARGV[2],
+    enable_logging: true,
+  )
+
+  webhook_url = ARGV[3].to_s.empty? ? nil : ARGV[3]
+  from_email = ARGV[4].to_s.empty? ? nil : ARGV[4]
+  config_file_path = ARGV[5].to_s.empty? ? './test/CONFIGFILE.yml' : ARGV[5]
+
+  data = YAML.load_file(config_file_path)
+
+  success = true
+
+  data.each do |call|
+    begin
+      puts "## RUN: #{call['method']}"
+
+      if call['method'] == 'callback_helper'
+        unione.send(call['method'], call['params']) do |events|
+          pp events
+        end
+      else
+        if call['method'] == 'send_email'
+          call['params']['message']['from_email'] = from_email if from_email
+        elsif call['method'] == 'set_webhook'
+          call['params']['url'] = webhook_url if webhook_url
+        end
+
+        unione.send(call['method'], call['params'])
+      end
+
+      puts "## => SUCCESS"
+      puts ""
+    rescue => e
+      success = false
+      puts "## => FAILED: #{e.message}"
+    end
+  end
+
+  success ? exit : abort
+end

data/config/response_schema/domain.yml

@@ -0,0 +1,74 @@
+get_dns_records:
+  type: object
+  required:
+    - status
+    - domain
+    - verification-record
+    - dkim
+  properties:
+    status:
+      type: string
+    domain:
+      type: string
+    verification-record:
+      type: string
+    dkim:
+      type: string
+validate_verification_record:
+  type: object
+  required:
+    - status
+    - message
+  properties:
+    status:
+      type: string
+    message:
+      type: string
+validate_dkim:
+  type: object
+  required:
+    - status
+    - message
+  properties:
+    status:
+      type: string
+    message:
+      type: string
+list_domains:
+  type: object
+  required:
+    - status
+    - domains
+  properties:
+    status:
+      type: string
+    domains:
+      items:
+        type: object
+        required:
+          - domain
+          - verification-record
+          - dkim
+        properties:
+        - domain:
+            type: string
+          verification-record:
+            type: object
+            required:
+              - value
+              - status
+            properties:
+            - value:
+                type: string
+              status:
+                type: string
+          dkim:
+            type: object
+            required:
+              - key
+              - status
+            properties:
+            - key:
+                type: string
+              status:
+                type: string

data/config/response_schema/email.yml

@@ -0,0 +1,23 @@
+send_email:
+  type: object
+  required:
+    - status
+    - job_id
+    - emails
+  properties:
+    status:
+      type: string
+    job_id:
+      type: string
+    emails:
+      items:
+        type: string
+    failed_emails:
+      type: object
+subscribe_email:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string

data/config/response_schema/event_dump.yml

@@ -0,0 +1,75 @@
+create_event_dump:
+  type: object
+  required:
+    - status
+    - dump_id
+  properties:
+    status:
+      type: string
+    dump_id:
+      type: string
+get_event_dump:
+  type: object
+  required:
+    - status
+    - event_dump
+  properties:
+    status:
+      type: string
+    event_dump:
+      type: object
+      required:
+        - dump_id
+        - dump_status
+      properties:
+        dump_id:
+          type: string
+        dump_status:
+          type: string
+        files:
+          items:
+            type: object
+            required:
+              - url
+              - size
+            properties:
+              url:
+                type: string
+              size:
+                type: integer
+list_event_dumps:
+  type: object
+  required:
+    - status
+    - event_dumps
+  properties:
+    status:
+      type: string
+    event_dumps:
+      items:
+        type: object
+        required:
+          - dump_id
+          - dump_status
+        properties:
+          dump_id:
+            type: string
+          dump_status:
+            type: string
+          files:
+            items:
+              required:
+                - url
+                - size
+              properties:
+                url:
+                  type: string
+                size:
+                  type: integer
+delete_event_dump:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string

data/config/response_schema/project.yml

@@ -0,0 +1,59 @@
+create_project:
+  type: object
+  required:
+    - status
+    - project_id
+    - project_api_key
+  properties:
+    status:
+      type: string
+    project_id:
+      type: string
+    project_api_key:
+      type: string
+update_project:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string
+    project_api_key:
+      type: string
+list_projects:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string
+    projects:
+      items:
+        type: object
+        required:
+          - id
+          - api_key
+          - name
+          - reg_time
+          - send_enabled
+          - custom_unsubscribe_url_enabled
+        properties:
+          id:
+            type: string
+          api_key:
+            type: string
+          name:
+            type: string
+          reg_time:
+            type: string
+          send_enabled:
+            type: boolean
+          custom_unsubscribe_url_enabled:
+            type: boolean
+delete_project:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string

data/config/response_schema/suppression.yml

@@ -0,0 +1,71 @@
+set_suppression:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string
+get_suppression:
+  type: object
+  required:
+    - status
+    - email
+    - suppressions
+  properties:
+    status:
+      type: string
+    email:
+      type: string
+    suppressions:
+      items:
+        type: object
+        required:
+          - cause
+          - source
+          - is_deletable
+          - created
+        properties:
+          project_id:
+            type: string
+          cause:
+            type: string
+          source:
+            type: string
+          is_deletable:
+            type: boolean
+          created:
+            type: string
+list_suppressions:
+  type: object
+  required:
+    - status
+    - suppressions
+    - cursor
+  properties:
+    status:
+      type: string
+    suppressions:
+      items:
+        type: object
+        required:
+          - cause
+          - source
+          - is_deletable
+          - created
+        properties:
+          project_id:
+            type: string
+          cause:
+            type: string
+          source:
+            type: string
+          is_deletable:
+            type: boolean
+          created:
+            type: string
+          cursor:
+            type: string
+delete_suppression:
+  type: object
+  required:
+    - status

data/config/response_schema/system.yml

@@ -0,0 +1,33 @@
+info:
+  type: object
+  required:
+    - status
+    - user_id
+    - email
+  properties:
+    status:
+      type: string
+    user_id:
+      type: integer
+    email:
+      type: string
+    accounting:
+      type: object
+      required:
+        - period_start
+        - period_end
+        - emails_included
+        - emails_sent
+      properties:
+      - period_start:
+          type: string
+        period_end:
+          type: string
+        emails_included:
+          type: integer
+        emails_sent:
+          type: integer
+    project_id:
+      type: string
+    project_name:
+      type: string

data/config/response_schema/tag.yml

@@ -0,0 +1,26 @@
+list_tags:
+  type: object
+  required:
+    - status
+    - tags
+  properties:
+    status:
+      type: string
+    tags:
+      items:
+        type: object
+        required:
+          - tag_id
+          - tag
+        properties:
+          tag_id:
+            type: integer
+          tag:
+            type: string
+delete_tag:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string

data/config/response_schema/template.yml

@@ -0,0 +1,134 @@
+set_template: &template
+  type: object
+  required:
+    - status
+    - template
+  properties:
+    status:
+      type: string
+    template:
+      type: object
+      required:
+        - id
+        - name
+        - editor_type
+        - subject
+        - from_name
+        - body
+        - headers
+        - attachments
+        - inline_attachments
+        - created
+        - user_id
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        editor_type:
+          type: string
+        subject:
+          type: string
+        from_name:
+          type: string
+        body:
+          type: object
+          required:
+            - html
+            - plaintext
+            - amp
+          properties:
+            html:
+              type: string, null
+            plaintext:
+              type: string, null
+            amp:
+              type: string, null
+        headers:
+          type: object
+        attachments:
+          items:
+            type: object
+        inline_attachments:
+          items:
+            type: object
+        options:
+          type: object
+          required:
+            - unsubscribe_url
+          properties:
+            unsubscribe_url:
+              type: string
+        created:
+          type: string
+        user_id:
+          type: integer
+get_template:
+  <<: *template
+list_templates:
+  type: object
+  required:
+    - status
+    - templates
+  properties:
+    status:
+      type: string
+    templates:
+      items:
+        type: object
+        required:
+          - id
+          - name
+          - editor_type
+          - subject
+          - body
+          - attachments
+          - inline_attachments
+          - created
+          - user_id
+        properties:
+          id:
+            type: string
+          name:
+            type: string
+          editor_type:
+            type: string
+          subject:
+            type: string
+          body:
+            type: object
+            required:
+              - html
+              - plaintext
+              - amp
+            properties:
+              html:
+                type: string, null
+              plaintext:
+                type: string, null
+              amp:
+                type: string, null
+          attachments:
+            items:
+              type: object
+          inline_attachments:
+            items:
+              type: object
+          options:
+            type: object
+            required:
+              - unsubscribe_url
+            properties:
+              unsubscribe_url:
+                type: string
+          created:
+            type: string
+          user_id:
+            type: integer
+delete_template:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string