base-api-io 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42cdec4ca272b8a89ce45864895274784f372c6cf92838a35bb5ab4739ee3bc0
-  data.tar.gz: 2de61d1b70ae7f85b13552e867b93a18c2bbea36e69831fdd833c2e0407de293
+  metadata.gz: 1e74548e5c837271421a840efb03a5f1628fd966d983c4c625b5e9f9cfb46030
+  data.tar.gz: 29fb96e090096e92481bf4f5dd469cb78209b1bb0e2c10c781a30e747abfb491
 SHA512:
-  metadata.gz: 391d588a22af6ea72224c8e3a19062599efa55cefc6f20c7f043928b271397f38ff84b37517afac187989f27023e089145d4ae05d4322dd812ba7988ecf63a02
-  data.tar.gz: b0e8778baf659dc613615f915283a9d7f3bdef937caab3cbd8ae7a929ce62bf702143f5abd6d0152dfbd1b970839a0e6d9bde7615f382b9d20abe5d9d0be2867
+  metadata.gz: d7ebd5db36d69905b2865580e7af8789e62c94a81044421d80fc9eabcaeb6edd661f5ce56238bd4ac37c9d071c9c0d081820a7843adc75e8e73aad34279b04e9
+  data.tar.gz: a0a1580044bbb747f038840f3976b75477c312add6df34d2228e13a8ef98981c50e9ddfe98e6cfb796caf5e2b7fbb68790133a5cc579bc9b97e9db393b408876

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    base-api-io (1.2.0)
+    base-api-io (1.3.0)
       faraday (~> 0.15.4)
 
 GEM

data/README.md

@@ -36,7 +36,7 @@ Just run this command: `gem install base-api-io`
 
    ```ruby
    client =
-     Base::Client.new(access_token: "your_access_token")
+     Base::Client.new(access_token: 'your_access_token')
    ```
 
 ### Sending email
@@ -47,11 +47,11 @@ Using the `emails` endpoint on the client you can send emails:
 # Sending an email
 email =
   client.emails.send(
-    from: "from@example.com",
-    to: "to@example.com",
-    subject: "Test Email",
-    html: "<b>Html message</b>",
-    text: "Text message")
+    from: 'from@example.com',
+    to: 'to@example.com',
+    subject: 'Test Email',
+    html: '<b>Html message</b>',
+    text: 'Text message')
 ```
 
 ### Users
@@ -67,17 +67,29 @@ users.metadata  # The metadata object containing the total count
 # Create a user with email / password
 user =
   client.users.create(
-    email: "test@user.com",
-    confirmation: "12345",
-    password: "12345")
+    email: 'test@user.com',
+    confirmation: '12345',
+    password: '12345',
+    custom_data: {
+      age: 32
+    })
 
 # Get a users details by the id
 user =
-  client.users.get("user_id")
+  client.users.get('user_id')
+
+# Update a users email or custom_data
+user =
+  client.users.update(
+    id: 'user_id',
+    email: 'test@user.com',
+    custom_data: {
+      age: 32
+    })
 
 # Delete a user by id
 user =
-  client.users.delete("user_id")
+  client.users.delete('user_id')
 ```
 
 ### Sessions
@@ -88,8 +100,8 @@ Using the `sessions` endpoint on the client you can authenticate a user.
 # Create a user with email / password
 user =
   client.sessions.authenticate(
-    email: "test@user.com",
-    password: "12345")
+    email: 'test@user.com',
+    password: '12345')
 ```
 
 ### Forgot Password Flow
@@ -99,14 +111,14 @@ Using the `passwords` endpoint on the client you can perform a forgot password f
 ```ruby
 # Create an forgot password token for the user with the given email address.
 token =
-  client.passwords.forgot_password(email: "test@user.com")
+  client.passwords.forgot_password(email: 'test@user.com')
 
 # Using that token set a new password.
 user =
   client.passwords.set_password(
     forgot_password_token: token.forgot_password_token,
-    confirmation: "123456",
-    password: "123456")
+    confirmation: '123456',
+    password: '123456')
 ```
 
 ### Files
@@ -129,19 +141,19 @@ file =
 
 # Get a file by id
 file =
-  client.files.get("file_id")
+  client.files.get('file_id')
 
 # Delete a file by id
 file =
-  client.files.delete("file_id")
+  client.files.delete('file_id')
 
 # Get a download URL to the file by id
 url =
-  client.files.download_url("file_id")
+  client.files.download_url('file_id')
 
 # Download the file by id into an IO
 io =
-  client.files.download("file_id")
+  client.files.download('file_id')
 ```
 
 ### Images
@@ -164,21 +176,62 @@ image =
 
 # Get a image by id
 image =
-  client.images.get("image_id")
+  client.images.get('image_id')
 
 # Delete a image by id
 image =
-  client.images.delete("image_id")
+  client.images.delete('image_id')
 
 # Get a link to a prcessed version (crop & resize) of the image by id
 url =
   client.images.image_url(i.id,
     crop: Base::Crop.new(width: 100, height: 100, top: 0, left: 0),
     resize: Base::Resize.new(width: 100, height: 100),
-    format: "jpg",
+    format: 'jpg',
     quality: 10)
 ```
 
+### Mailing Lists
+
+A project can have many mailing lists which can be managed from the interface.
+
+The `mailingLists` endpoint allows you to programatically subscribe / unsubscribe
+emails to a mailing list and send emails to all subscribes using a single call.
+
+```ruby
+# List mailing lists
+lists = client.mailing_lists.list(page: 1, per_page: 10)
+lists.items     # The array of mailing lists
+lists.metadata  # The metadata object containing the total count
+
+# Get a mailing list by id
+list =
+  client.mailing_lists.get('list_id')
+
+# Subscribe an email to a mailing list.
+list =
+  client.mailing_lists.subscribe(id: 'mailing_list_id', email: 'test@user.com')
+
+# Unsubscribe an email from a mailing list.
+list =
+  client.mailing_lists.unsubscribe(id: 'mailing_list_id', email: 'test@user.com')
+
+# Get a public unsubscribe url for the given mailing list and email which
+# when click unsubscribes a user from the mailing list and redirects to the
+# unsubscribe_redirect_url of the list.
+url =
+  client.mailing_lists.unsubscribe_url(id: 'mailing_list_id', email: 'test@user.com')
+
+# Send the same email to all of the subscribers
+results =
+  client.mailing_lists.send(
+    from: 'from@example.com',
+    id: 'mailing_list_id',
+    subject: 'subject',
+    html: 'HTML',
+    text: 'Text')
+```
+
 ## Development
 
 This library uses [Faraday](https://lostisland.github.io/faraday/), you can run the

data/lib/base/client.rb

@@ -4,6 +4,7 @@ require_relative 'models/crop'
 require_relative 'models/resize'
 
 require_relative 'endpoint'
+require_relative 'endpoints/mailing_lists'
 require_relative 'endpoints/passwords'
 require_relative 'endpoints/sessions'
 require_relative 'endpoints/images'
@@ -14,6 +15,9 @@ require_relative 'endpoints/files'
 module Base
   # A client containing all the endpoints.
   class Client
+    # Endpoint for the mailing lists
+    attr_reader :mailing_lists
+
     # Endpoint for the forgot password flow.
     attr_reader :passwords
 
@@ -69,6 +73,12 @@ module Base
           access_token: access_token,
           url: url
         )
+
+      @mailing_lists =
+        Endpoints::MailingLists.new(
+          access_token: access_token,
+          url: url
+        )
     end
   end
 end

data/lib/base/endpoints/mailing_lists.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Base
+  module Endpoints
+    # This endpoint contains methods for managing mailing lists.
+    class MailingLists < Endpoint
+      # Initializes this endpoint.
+      def initialize(access_token:, url:)
+        @path = 'mailing_lists'
+        super
+      end
+
+      # Lists the mailing lists of a project
+      def list(page: 1, per_page: 10)
+        request do
+          response =
+            connection.get('', per_page: per_page, page: page)
+
+          parse(response.body)
+        end
+      end
+
+      # Sends an email with the given parameters.
+      #
+      # If there is no sending domain set up all emails will use the
+      # `proxy@base-api.io` sender and ignore the given one, also in this case
+      # there is a rate limit which is 30 emails in an hour.
+      #
+      # If there is a sending domain, the sender must match that domain
+      # otherwise it will return an error.
+      def send(id:, subject:, from:, html:, text:)
+        request do
+          response =
+            connection.post("#{id}/send",
+                            'from' => from,
+                            'subject' => subject,
+                            'html' => html,
+                            'text' => text)
+
+          parse(response.body)
+        end
+      end
+
+      # Subscribes an email to the mailing list with the given id.
+      def subscribe(id:, email:)
+        request do
+          response =
+            connection.post("#{id}/subscribe", 'email' => email)
+
+          parse(response.body)
+        end
+      end
+
+      # Unsubscribes an email from the mailing list with the given id.
+      def unsubscribe(id:, email:)
+        request do
+          response =
+            connection.post("#{id}/unsubscribe", 'email' => email)
+
+          parse(response.body)
+        end
+      end
+
+      # Returns the unsubscribe url for the given email of list the given id.
+      def unsubscribe_url(id:, email:)
+        token =
+          Base64.encode64("#{id}:#{email}")
+
+        "#{connection.url_prefix}unsubscribe?token=#{token}"
+      end
+
+      # Returns the metadata of the mailing list with the given ID.
+      def get(id)
+        request do
+          response =
+            connection.get id
+
+          parse(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/base/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Base
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base-api-io
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Gusztáv Szikszai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,6 +119,7 @@ files:
 - lib/base/endpoints/emails.rb
 - lib/base/endpoints/files.rb
 - lib/base/endpoints/images.rb
+- lib/base/endpoints/mailing_lists.rb
 - lib/base/endpoints/passwords.rb
 - lib/base/endpoints/sessions.rb
 - lib/base/endpoints/users.rb