Merge pull request #78 from mailtrap/add-projects-api

Add Sandbox Projects API

Author: i7an

README.md

@@ -105,22 +105,7 @@ client.send_batch(
 )
 ```
 
-### Email Templates API
-
-```ruby
-require 'mailtrap'
-
-client = Mailtrap::Client.new(api_key: 'your-api-key')
-templates = Mailtrap::EmailTemplatesAPI.new 3229, client
-
-templates.create(
-  name: 'Welcome Email',
-  subject: 'Welcome to Mailtrap!',
-  body_html: '<h1>Hello</h1>',
-  body_text: 'Hello',
-  category: 'welcome'
-)
-```
+### Usage Examples
 
 Refer to the [`examples`](examples) folder for more examples:
 
@@ -129,6 +114,7 @@ Refer to the [`examples`](examples) folder for more examples:
 - [Batch Sending](examples/batch.rb)
 - [ActionMailer](examples/action_mailer.rb)
 - [Email Templates API](examples/email_templates_api.rb)
+- [Projects API](examples/projects_api.rb)
 
 ### Content-Transfer-Encoding
 
@@ -178,12 +164,18 @@ If you use classes which have `Sending` namespace, remove the namespace like in
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/mailtrap/mailtrap-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
 
+All contributions are required to have rspec tests covering its functionality.
+
+Please be sure to update [README](README.md) with new examples and features when applicable.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

examples/projects_api.rb

@@ -0,0 +1,28 @@
+require 'mailtrap'
+
+account_id = 3229
+client = Mailtrap::Client.new(api_key: 'your-api-key')
+projects_api = Mailtrap::ProjectsAPI.new(account_id, client)
+
+# Set your API credentials as environment variables
+# export MAILTRAP_API_KEY='your-api-key'
+# export MAILTRAP_ACCOUNT_ID=your-account-id
+#
+# projects_api = Mailtrap::ProjectsAPI.new
+
+# Get all projects
+projects_api.list
+
+# Create a new project
+project = projects_api.create(
+  name: 'Example Project'
+)
+
+# Get a project
+project = projects_api.get(project.id)
+
+# Update a project
+project = projects_api.update(project.id, name: 'New Project name')
+
+# Delete a project
+projects_api.delete(project.id)

lib/mailtrap.rb

@@ -10,6 +10,7 @@
 require_relative 'mailtrap/contact_fields_api'
 require_relative 'mailtrap/contact_imports_api'
 require_relative 'mailtrap/suppressions_api'
+require_relative 'mailtrap/projects_api'
 
 module Mailtrap
   # @!macro api_errors

lib/mailtrap/contact.rb

@@ -29,10 +29,5 @@ def initialize(options)
     def newly_created?
       @action != 'updated'
     end
-
-    # @return [Hash] The contact attributes as a hash
-    def to_h
-      super.compact
-    end
   end
 end

lib/mailtrap/contact_field.rb

@@ -9,10 +9,5 @@ module Mailtrap
   #   Allowed values: text, integer, float, boolean, date
   # @attr_reader merge_tag [String] Personalize your campaigns by adding a merge tag.
   #   This field will be replaced with unique contact details for each recipient (max 80 characters)
-  ContactField = Struct.new(:id, :name, :data_type, :merge_tag, keyword_init: true) do
-    # @return [Hash] The contact field attributes as a hash
-    def to_h
-      super.compact
-    end
-  end
+  ContactField = Struct.new(:id, :name, :data_type, :merge_tag, keyword_init: true)
 end

lib/mailtrap/contact_import.rb

@@ -14,10 +14,5 @@ module Mailtrap
     :updated_contacts_count,
     :contacts_over_limit_count,
     keyword_init: true
-  ) do
-    # @return [Hash] The contact attributes as a hash
-    def to_h
-      super.compact
-    end
-  end
+  )
 end

lib/mailtrap/contact_list.rb

@@ -5,10 +5,5 @@ module Mailtrap
   # @see https://api-docs.mailtrap.io/docs/mailtrap-api-docs/6ec7a37234af2-contact-list
   # @attr_reader id [Integer] The contact list ID
   # @attr_reader name [String] The name of the contact list
-  ContactList = Struct.new(:id, :name, keyword_init: true) do
-    # @return [Hash] The contact list attributes as a hash
-    def to_h
-      super.compact
-    end
-  end
+  ContactList = Struct.new(:id, :name, keyword_init: true)
 end

lib/mailtrap/email_template.rb

@@ -26,10 +26,5 @@ module Mailtrap
     :created_at,
     :updated_at,
     keyword_init: true
-  ) do
-    # @return [Hash] The template attributes as a hash
-    def to_h
-      super.compact
-    end
-  end
+  )
 end

lib/mailtrap/inbox.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Inbox
+  # @see https://api-docs.mailtrap.io/docs/mailtrap-api-docs/ee252e413d78a-create-project
+  # @attr_reader id [Integer] The inbox ID
+  # @attr_reader name [String] The inbox name
+  # @attr_reader username [String] The inbox username
+  # @attr_reader password [String, nil] The inbox password
+  # @attr_reader max_size [Integer] The maximum inbox size in MB
+  # @attr_reader status [String] The inbox status
+  # @attr_reader email_username [String] The email username
+  # @attr_reader email_username_enabled [Boolean] Whether the email username is enabled
+  # @attr_reader sent_messages_count [Integer] The count of sent messages
+  # @attr_reader forwarded_messages_count [Integer] The count of forwarded messages
+  # @attr_reader used [Integer] The used inbox size in MB
+  # @attr_reader forward_from_email_address [String] The forwarding email address
+  # @attr_reader project_id [Integer] The associated project ID
+  # @attr_reader domain [String] The inbox domain
+  # @attr_reader pop3_domain [String] The POP3 domain
+  # @attr_reader email_domain [String] The email domain
+  # @attr_reader api_domain [String] The API domain
+  # @attr_reader emails_count [Integer] The total number of emails
+  # @attr_reader emails_unread_count [Integer] The number of unread emails
+  # @attr_reader last_message_sent_at [String, nil] The timestamp of the last sent message
+  # @attr_reader smtp_ports [Array<Integer>] The list of SMTP ports
+  # @attr_reader pop3_ports [Array<Integer>] The list of POP3 ports
+  # @attr_reader max_message_size [Integer] The maximum message size in MB
+  # @attr_reader permissions [Hash] List of permissions
+  Inbox = Struct.new(
+    :id,
+    :name,
+    :username,
+    :password,
+    :max_size,
+    :status,
+    :email_username,
+    :email_username_enabled,
+    :sent_messages_count,
+    :forwarded_messages_count,
+    :used,
+    :forward_from_email_address,
+    :project_id,
+    :domain,
+    :pop3_domain,
+    :email_domain,
+    :api_domain,
+    :emails_count,
+    :emails_unread_count,
+    :last_message_sent_at,
+    :smtp_ports,
+    :pop3_ports,
+    :max_message_size,
+    :permissions,
+    keyword_init: true
+  )
+end

lib/mailtrap/project.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Project
+  # @see https://api-docs.mailtrap.io/docs/mailtrap-api-docs/ee252e413d78a-create-project
+  # @attr_reader id [Integer] The project ID
+  # @attr_reader name [String] The project name
+  # @attr_reader share_links [Hash] Admin and viewer share links
+  # @attr_reader inboxes [Array<Mailtrap::Inbox>] Array of inboxes
+  # @attr_reader permissions [Hash] List of permissions
+  #
+  Project = Struct.new(
+    :id,
+    :name,
+    :share_links,
+    :inboxes,
+    :permissions,
+    keyword_init: true
+  )
+end