postman_mta 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7c0fdec2a65670703adfc59f8374a058f0a466e
-  data.tar.gz: f542a2ebc846f57b555d0c80a4a7e67877e32141
+  metadata.gz: d204a94e4b429c874c194ebcfddbc02969cc92c2
+  data.tar.gz: 4b42a3e90b282fd6a78cbae5153d16f269900776
 SHA512:
-  metadata.gz: 49723e8573284422b37c5f5f9289dbc9487c913e12ebf1e39a4cbc8518fe6f49deda8253dafc4e636cab89dfd586aafacc8f120bf3c6497e2d2dfd568491ce74
-  data.tar.gz: 49196710bae24dd7354b60dc70b322d126261bd735ad8e172dcbe5c1d7531cf2aa70505e081297adc12eb95a7f0e097fe2a7ff99edbb46f04e0a08fc64c75605
+  metadata.gz: 23c96c6b8108320788c4b358be7444f09cfa43f3381dd642eb4d37346bd14f8640e539a57a3811defd8061e652a15d80388e02bd5edbafafd229a6b38982b7cb
+  data.tar.gz: d2e16e3f811071a3654198ae354bd5873f7f4b6d1b9d7ece0c980da317005d9fab13f4bca634eacc7432711190a8088bdf5d9b521b6467df06cdc4c078b00144

data/README.md

@@ -1,8 +1,12 @@
-# PostmanMta
+# Postman MTA
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/postman_mta`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://semaphoreci.com/api/v1/igormalinovskiy/postman_mta/branches/master/shields_badge.svg)](https://semaphoreci.com/igormalinovskiy/postman_mta)
+[![Code Climate](https://codeclimate.com/github/psyipm/postman_mta/badges/gpa.svg)](https://codeclimate.com/github/psyipm/postman_mta)
+[![Gem Version](https://badge.fury.io/rb/postman_mta.svg)](https://badge.fury.io/rb/postman_mta)
 
-TODO: Delete this and the text above, and describe your gem
+Rails gem to easy integrate Postman to your application
+
+This gem will add some routes to the application to forward requests from frontend to postman API
 
 ## Installation
 
@@ -22,7 +26,76 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Mount engine in `config/routes.rb`:
+
+```ruby
+mount PostmanMta::Engine => '/mta'
+```
+
+Then configure the gem:
+
+```ruby
+# config/initializers/postman_mta.rb
+PostmanMta.setup do |config|
+  config.api_key = ENV['POSTMAN_API_KEY']
+  config.api_secret = ENV['POSTMAN_API_SECRET']
+  config.api_endpoint = ENV['POSTMAN_API_ENDPOINT']
+end
+```
+
+This will add the following routes:
+
+```
+Routes for PostmanMta::Engine:
+           messages POST   /messages(.:format)                                  postman_mta/messages#create
+            message GET    /messages/:id(.:format)                              postman_mta/messages#show
+conversation_labels POST   /conversations/:conversation_id/labels(.:format)     postman_mta/labels#create
+ conversation_label DELETE /conversations/:conversation_id/labels/:id(.:format) postman_mta/labels#destroy
+  conversation_tags POST   /conversations/:conversation_id/tags(.:format)       postman_mta/tags#create
+   conversation_tag DELETE /conversations/:conversation_id/tags/:id(.:format)   postman_mta/tags#destroy
+      conversations GET    /conversations(.:format)                             postman_mta/conversations#index
+       conversation GET    /conversations/:id(.:format)                         postman_mta/conversations#show
+```
+
+for `messages#create` the following parameters accepted:
+
+```ruby
+    attribute :from, String
+    attribute :to, Array # The array of recepient email addresses
+    attribute :plain_body, String
+    attribute :html_body, String
+    attribute :bcc, Array # The array of bcc email addresses
+    attribute :cc, Array # The array of cc email addresses
+    attribute :reply_to, String
+    attribute :in_reply_to, String
+    attribute :subject, String
+    attribute :attachments, Array # [{ base64: "YXNmYXNmYXNm\n", name: 'file.txt', content_type: 'text/plain' }]
+```
+
+Messages are grouped in conversations. Conversations can be accessed using corresponding `#index` and `#show` actions.
+
+Filter parameters for `conversations#index`:
+
+```ruby
+    { tag_title: 'some_tag', tag_value: 'some_value' }
+    { label: 'some_label_title' }
+```
+
+Conversations can be tagged and/or labeled. Labels and tags can be used for search. To create new tag for conversation, send the following params to `tags#create`:
+
+```ruby
+    attribute :title, String
+    attribute :value, String
+    attribute :conversation_id, Integer
+```
+
+Params for label:
+
+```ruby
+    attribute :title, String
+    attribute :sort_order, Integer
+    attribute :color, String
+```
 
 ## Development
 
@@ -32,7 +105,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/postman_mta.
+Bug reports and pull requests are welcome on GitHub at https://github.com/psyipm/postman_mta.
 
 ## License
 

data/app/controllers/postman_mta/conversations_controller.rb

@@ -1,11 +1,29 @@
 module PostmanMta
   class ConversationsController < ApplicationController
     def index
-      render json: conversation.index(filter_params).as_json
+      render conversation.index(permitted_params)
+    end
+
+    [:inbox, :sent, :spam, :trash].each do |folder|
+      define_method folder do
+        render conversation.folder(folder, permitted_params)
+      end
     end
 
     def show
-      render json: conversation.find(params[:id]).as_json
+      render conversation.find(params[:id])
+    end
+
+    def read
+      render conversation.mark_as_read(permitted_params)
+    end
+
+    def destroy
+      render conversation.move_to_trash(params[:id])
+    end
+
+    def move
+      render conversation.move(permitted_params)
     end
 
     private
@@ -14,7 +32,7 @@ module PostmanMta
       @conversation ||= PostmanMta::Conversation.new
     end
 
-    def filter_params
+    def permitted_params
       params.permit!
     end
   end

data/app/controllers/postman_mta/labels_controller.rb

@@ -1,11 +1,11 @@
 module PostmanMta
   class LabelsController < ApplicationController
     def create
-      render json: label.create(label_params).as_json
+      render label.create(label_params)
     end
 
     def destroy
-      render json: label.destroy(params[:id]).as_json
+      render label.destroy(params[:id])
     end
 
     private

data/app/controllers/postman_mta/messages_controller.rb

@@ -1,11 +1,11 @@
 module PostmanMta
   class MessagesController < ApplicationController
     def show
-      render json: message.find(params[:id]).as_json
+      render message.find(params[:token])
     end
 
     def create
-      render json: message.create(message_params).as_json
+      render message.create(message_params)
     end
 
     private

data/app/controllers/postman_mta/routes_controller.rb

@@ -0,0 +1,13 @@
+module PostmanMta
+  class RoutesController < ApplicationController
+    def index
+      render route.index
+    end
+
+    private
+
+    def route
+      @route ||= PostmanMta::Route.new
+    end
+  end
+end

data/app/controllers/postman_mta/tags_controller.rb

@@ -1,11 +1,11 @@
 module PostmanMta
   class TagsController < ApplicationController
     def create
-      render json: tag.create(tag_params).as_json
+      render tag.create(tag_params)
     end
 
     def destroy
-      render json: tag.destroy(params[:id]).as_json
+      render tag.destroy(params[:id])
     end
 
     private

data/app/models/postman_mta/conversation.rb

@@ -4,8 +4,28 @@ module PostmanMta
       get('/api/v1/conversations', body: params)
     end
 
+    def folder(folder, params = {})
+      params = {
+        folder: folder
+      }.merge(params)
+
+      get('/api/v1/conversations', body: params)
+    end
+
     def find(conversation_id)
       get("/api/v1/conversations/#{conversation_id}")
     end
+
+    def move_to_trash(conversation_id)
+      delete("/api/v1/conversations/#{conversation_id}/trash")
+    end
+
+    def mark_as_read(params = {})
+      patch('/api/v1/conversations/read', body: params)
+    end
+
+    def move(params = {})
+      patch('/api/v1/conversations/move', body: params)
+    end
   end
 end

data/app/models/postman_mta/message.rb

@@ -1,7 +1,7 @@
 module PostmanMta
   class Message < ApplicationModel
-    def find(message_id)
-      get("/api/v1/messages/#{message_id}")
+    def find(token)
+      get("/api/v1/messages/#{token}")
     end
 
     def create(params)

data/app/models/postman_mta/route.rb

@@ -0,0 +1,7 @@
+module PostmanMta
+  class Route < ApplicationModel
+    def index
+      get('/api/v1/routes')
+    end
+  end
+end

data/config/routes.rb

@@ -1,8 +1,18 @@
 PostmanMta::Engine.routes.draw do
-  resources :messages, only: [:show, :create]
+  resources :messages, only: [:show, :create], param: :token
+
+  resources :conversations, only: [:index, :show, :destroy] do
+    [:inbox, :sent, :spam, :trash].each do |folder|
+      match folder, on: :collection, via: :get
+    end
+
+    match :starred, on: :collection, via: :get, to: 'conversations#index'
+    match :read, on: :collection, via: [:put, :patch]
+    match :move, on: :collection, via: [:put, :patch]
 
-  resources :conversations, only: [:index, :show] do
     resources :labels, only: [:create, :destroy]
     resources :tags, only: [:create, :destroy]
   end
+
+  resources :routes, only: :index
 end

data/lib/postman_mta/api_client.rb

@@ -18,7 +18,9 @@ module PostmanMta
         request_method: request_type.upcase, path: path
       ).headers
 
-      self.class.send(request_type.downcase, path, { headers: headers }.merge(options)).parsed_response
+      response = self.class.send(request_type.downcase, path, { headers: headers }.merge(options))
+
+      { json: response.parsed_response.as_json, status: response.code }
     end
   end
 end

data/lib/postman_mta/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PostmanMta
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/postman_mta.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7', '>= 4.7.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'reek'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postman_mta
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Malinovskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,11 +122,13 @@ files:
 - app/controllers/postman_mta/conversations_controller.rb
 - app/controllers/postman_mta/labels_controller.rb
 - app/controllers/postman_mta/messages_controller.rb
+- app/controllers/postman_mta/routes_controller.rb
 - app/controllers/postman_mta/tags_controller.rb
 - app/models/postman_mta/application_model.rb
 - app/models/postman_mta/conversation.rb
 - app/models/postman_mta/label.rb
 - app/models/postman_mta/message.rb
+- app/models/postman_mta/route.rb
 - app/models/postman_mta/tag.rb
 - bin/console
 - bin/setup