litmus-instant 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b33b2790b147305678f1f7e5a78464370bfe0e30
-  data.tar.gz: cff4d00209f901e4bb1206de3a8c4bef0eaae521
+  metadata.gz: ad9b8fa8bc97d92ca25106dd1099b488861f4b9d
+  data.tar.gz: b14bc1abf31ab0bd9c0b9ea0a88551300ec05e73
 SHA512:
-  metadata.gz: c3793e2e0cc82c28606803293972475c6c4c7cf9c6952072a4484afae498f1bf24ecb52085e737e38f88d2b5b550bb44ba8bc2aa22cd05ef92b29582a7cf959b
-  data.tar.gz: c3daaecb703ed155b23d67d5b76513e0f0a6680c2be05a0393378b2cbe2cd098689ed35da32f1073bfd991891e4bbfd2968715b794cdac703180ec40d0a2d3cd
+  metadata.gz: aeb6406d2d3776a1a10ce6c4a1735551ff39d7e91ecda76a6ef08c662113c3da44f2c3a60c3972a255923bf9fd95ef895574cffe29b56d312a17ef8ff6b8b261
+  data.tar.gz: 3370c2c65e935661b5873433fbc569457dc97baf1483a3e450876a9232cabfb7101ef08b9ccb2ff3d6d0d861f655f12fb6297cd08e0db50c5b37955820857713

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.3.1
 before_install: gem install bundler -v 1.10.6

data/Procfile

@@ -0,0 +1 @@
+web: cd examples && bundle exec rackup config.ru -p $PORT

data/README.md

@@ -49,6 +49,19 @@ This could be used in a Rails erb template like so
 <%= image_tag @preview_url %>
 ```
 
+### OAuth and API client instantiation
+
+Individual API client objects can be instantiated and expose an identical
+interface to the class methods on `Litmus::Instant`, this the recommended
+approach for acting on behalf of multiple Litmus users within the same
+application, as each client can be configured with an OAuth token for each
+authorized user in a thread safe manner:
+
+```ruby
+api_client = Litmus::Instant::Client.new(oauth_token: "XXX")
+api_client.create_email(plain_text: "Goodbye world.")
+```
+
 ### Performance
 
 In the example above the capture wouldn't be initiated until the end user's browser made the HTTP GET request to the preview URL. This would mean waiting the full capture time (a number of seconds) before the image data began to transfer.
@@ -87,6 +100,8 @@ Litmus::Instant.prefetch_previews(
 
 For further information see the [performance section](https://litmus.com/partners/api/documentation/instant/04-performance/) of the Instant API documentation.
 
+
+
 ### Handling errors
 
 Various errors may occur can occur during normal usage of the API, please code defensively to handle these.

data/examples/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
 
 gem "sinatra"
+gem "httparty"
 gem "litmus-instant", path: "../"

data/examples/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../instant-api-ruby
   specs:
-    litmus-instant (0.1.0)
+    litmus-instant (0.2.0)
       httparty (~> 0.13.5)
 
 GEM
@@ -25,8 +25,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  httparty
   litmus-instant!
   sinatra
 
 BUNDLED WITH
-   1.10.6
+   1.12.5

data/examples/README.md

@@ -1,5 +1,7 @@
 # Examples of InstantAPI usage
 
+See also https://github.com/litmus/litmus-oauth-example
+
 ## Prerequisites
 
 - ruby

data/examples/config.ru

@@ -0,0 +1,2 @@
+require "./example_oauth"
+run Sinatra::Application

data/fixtures/vcr_cassettes/Litmus_Instant/Litmus_Instant_Client_provides_Litmus_Instant_class_methods_as_instance_methods.yml

@@ -0,0 +1,191 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://instant-api.litmus.com/v1/clients
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 20 Jun 2016 18:34:56 GMT
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '845'
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=3600; includeSubdomains; preload
+      X-Frame-Options:
+      - DENY
+      X-Content-Type-Options:
+      - nosniff
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          "ANDROID4",
+          "ANDROIDGMAILAPP",
+          "AOLONLINE",
+          "APPMAIL8",
+          "APPMAIL9",
+          "CHROMEAOLONLINE",
+          "CHROMEGMAILNEW",
+          "CHROMEGMXDE",
+          "CHROMEGOOGLEAPPS",
+          "CHROMEGOOGLEINBOX",
+          "CHROMEOFFICE365",
+          "CHROMEOUTLOOKCOM",
+          "CHROMEWEBDE",
+          "CHROMEYAHOO",
+          "COLORBLIND",
+          "FFAOLONLINE",
+          "FFGMAILNEW",
+          "FFGMXDE",
+          "FFGOOGLEAPPS",
+          "FFGOOGLEINBOX",
+          "FFOFFICE365",
+          "FFOUTLOOKCOM",
+          "FFWEBDE",
+          "FFYAHOO",
+          "GMAILNEW",
+          "GMXDE",
+          "GOOGLEAPPS",
+          "IPAD",
+          "IPADMINI",
+          "IPHONE5S",
+          "IPHONE5SIOS8",
+          "IPHONE6",
+          "IPHONE6PLUS",
+          "IPHONE6S",
+          "IPHONE6SPLUS",
+          "NOTES7",
+          "NOTES8",
+          "NOTES85",
+          "NOTES9",
+          "OFFICE365",
+          "OL2000",
+          "OL2002",
+          "OL2003",
+          "OL2007",
+          "OL2010",
+          "OL2011",
+          "OL2013",
+          "OL2013DPI120",
+          "OL2015",
+          "OL2016",
+          "OUTLOOKCOM",
+          "PLAINTEXT",
+          "THUNDERBIRDLATEST",
+          "WEBDE",
+          "YAHOO"
+        ]
+    http_version: 
+  recorded_at: Mon, 20 Jun 2016 18:34:58 GMT
+- request:
+    method: get
+    uri: https://instant-api.litmus.com/v1/clients
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 20 Jun 2016 18:34:57 GMT
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '845'
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=3600; includeSubdomains; preload
+      X-Frame-Options:
+      - DENY
+      X-Content-Type-Options:
+      - nosniff
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          "ANDROID4",
+          "ANDROIDGMAILAPP",
+          "AOLONLINE",
+          "APPMAIL8",
+          "APPMAIL9",
+          "CHROMEAOLONLINE",
+          "CHROMEGMAILNEW",
+          "CHROMEGMXDE",
+          "CHROMEGOOGLEAPPS",
+          "CHROMEGOOGLEINBOX",
+          "CHROMEOFFICE365",
+          "CHROMEOUTLOOKCOM",
+          "CHROMEWEBDE",
+          "CHROMEYAHOO",
+          "COLORBLIND",
+          "FFAOLONLINE",
+          "FFGMAILNEW",
+          "FFGMXDE",
+          "FFGOOGLEAPPS",
+          "FFGOOGLEINBOX",
+          "FFOFFICE365",
+          "FFOUTLOOKCOM",
+          "FFWEBDE",
+          "FFYAHOO",
+          "GMAILNEW",
+          "GMXDE",
+          "GOOGLEAPPS",
+          "IPAD",
+          "IPADMINI",
+          "IPHONE5S",
+          "IPHONE5SIOS8",
+          "IPHONE6",
+          "IPHONE6PLUS",
+          "IPHONE6S",
+          "IPHONE6SPLUS",
+          "NOTES7",
+          "NOTES8",
+          "NOTES85",
+          "NOTES9",
+          "OFFICE365",
+          "OL2000",
+          "OL2002",
+          "OL2003",
+          "OL2007",
+          "OL2010",
+          "OL2011",
+          "OL2013",
+          "OL2013DPI120",
+          "OL2015",
+          "OL2016",
+          "OUTLOOKCOM",
+          "PLAINTEXT",
+          "THUNDERBIRDLATEST",
+          "WEBDE",
+          "YAHOO"
+        ]
+    http_version: 
+  recorded_at: Mon, 20 Jun 2016 18:34:59 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/Litmus_Instant/Litmus_Instant_Client_uses_its_own_config.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://instant-api.litmus.com/v1/emails
+    body:
+      encoding: UTF-8
+      string: '{"plain_text":"boo"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Authorization:
+      - Basic aW52YWxpZF9rZXk6
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 20 Jun 2016 18:34:57 GMT
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '328'
+      Connection:
+      - keep-alive
+      Www-Authenticate:
+      - Basic realm="Litmus Instant API"
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "status": 401,
+          "title": "Unauthorized",
+          "description": "API Authentication credentials were missing or incorrect. Make sure the credentials you're making the request with match those you were provided. If you're stuck, please email resellers@litmus.com and we'll have a Support Engineer reach out as soon as possible."
+        }
+    http_version: 
+  recorded_at: Mon, 20 Jun 2016 18:34:59 GMT
+- request:
+    method: post
+    uri: https://instant-api.litmus.com/v1/emails
+    body:
+      encoding: UTF-8
+      string: '{"plain_text":"boo"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Authorization:
+      - Basic Y3hkNHR1c3F3b2tnZ2dseGl6ZDl2cDd6bXV4dmo2eG95a2UxOg==
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 20 Jun 2016 18:34:57 GMT
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '58'
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=3600; includeSubdomains; preload
+      X-Frame-Options:
+      - DENY
+      X-Content-Type-Options:
+      - nosniff
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "email_guid": "98f7d82b-982d-44f2-8818-45a2284cb974"
+        }
+    http_version: 
+  recorded_at: Mon, 20 Jun 2016 18:35:00 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/Litmus_Instant/client_configurations/returns_a_Hash_of_clients_and_their_available_options.yml

@@ -19,11 +19,11 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 06 Oct 2015 11:30:30 GMT
+      - Mon, 20 Jun 2016 11:43:49 GMT
       Content-Type:
       - application/json;charset=utf-8
       Content-Length:
-      - '5766'
+      - '7236'
       Connection:
       - keep-alive
       Strict-Transport-Security:
@@ -151,14 +151,6 @@ http_interactions:
               "blocked"
             ]
           },
-          "APPMAIL7": {
-            "orientation_options": [
-              "vertical"
-            ],
-            "images_options": [
-              "allowed"
-            ]
-          },
           "APPMAIL8": {
             "orientation_options": [
               "vertical"
@@ -397,6 +389,15 @@ http_interactions:
               "allowed"
             ]
           },
+          "OL2016": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
           "ANDROIDGMAILAPP": {
             "orientation_options": [
               "vertical"
@@ -412,8 +413,103 @@ http_interactions:
             "images_options": [
               "allowed"
             ]
+          },
+          "IPHONE6S": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed"
+            ]
+          },
+          "IPHONE6SPLUS": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed"
+            ]
+          },
+          "GMXDE": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "FFGMXDE": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "CHROMEGMXDE": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "WEBDE": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "FFWEBDE": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "CHROMEWEBDE": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "APPMAIL9": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed",
+              "blocked"
+            ]
+          },
+          "FFGOOGLEINBOX": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed"
+            ]
+          },
+          "CHROMEGOOGLEINBOX": {
+            "orientation_options": [
+              "vertical"
+            ],
+            "images_options": [
+              "allowed"
+            ]
           }
         }
     http_version: 
-  recorded_at: Tue, 06 Oct 2015 11:30:33 GMT
+  recorded_at: Mon, 20 Jun 2016 11:43:51 GMT
 recorded_with: VCR 2.9.3