flimper_poncho 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ea0837fd9b1a91ba66b8f955f58384d52b2b90910a64f449f09551dc9316fd
-  data.tar.gz: 49bfe02a089d6d3f838d1e5e72fb0ba4ba4a781a63dd1e6778cfe705a6efee77
+  metadata.gz: 7fc01415394547ff040e49b1a262b2fc437dfb5176fc941e066b2a0a2328a050
+  data.tar.gz: 8fb8ee3817ad0e76afb7b0b374da4ccfb37fe8cbbaba867d9d019e711ac2bd0f
 SHA512:
-  metadata.gz: 8dd3f92abc84aadaec6a61dd3a1b5adf25a3877ffa85badb1299ea3f569d1a635878969dda99968e0f1337853dfdd13bf88538c693e0d31439421420ceee3899
-  data.tar.gz: d7fafbba43dacdccb320298b76baa9384f7d7a36a8b286c13ab58afb13f37452d5712d2e6e965bd309c832ec81bd0e88ebd5aaaf5b56c8b6dcd0fb0e3c1dc06c
+  metadata.gz: 88f9c8adae9140491fea28c79cd41d52e7ef48d361ca2e916b0469548c451898f3f2e78ae3fdea54715d6eedc5d1b464b5a37bd4f7cb155af47f0f3cbbd458ed
+  data.tar.gz: 2757b8e1044c7ab2f752e101cd58f8cad1fff4167d9fe6d7afcc2f3b80e5f9311f4a65a667b81b708c641997b671c0203aa710491652c18d077063cfbf80ace1

data/Gemfile.lock

@@ -1,39 +1,25 @@
 PATH
   remote: .
   specs:
-    flimper_poncho (0.1.0)
-      active_interaction (~> 3.7)
+    flimper_poncho (0.1.1)
       faraday (~> 0.15.4)
       jwt (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    active_interaction (3.7.1)
-      activemodel (>= 4, < 7)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     byebug (11.0.1)
-    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     hashdiff (0.3.8)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     jwt (2.1.0)
-    minitest (5.11.3)
     multipart-post (2.0.0)
     parallel (1.17.0)
     parser (2.6.2.0)
@@ -65,10 +51,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.0)
     safe_yaml (1.0.5)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     unicode-display_width (1.5.0)
+    vcr (4.0.0)
     webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -84,6 +68,7 @@ DEPENDENCIES
   rake (~> 12.3)
   rspec (~> 3.8)
   rubocop (~> 0.66.0)
+  vcr (~> 4.0)
   webmock (~> 3.5.1)
 
 BUNDLED WITH

data/README.md

@@ -28,9 +28,21 @@ Or install it yourself as:
 
 ## Usage
 
-- Create a user session:
+- Issue an ApiClient jwt:
 
-  `FlimperPoncho::UserSession::Create.run!(email: 'test@flimper.com', password: 'password')`
+  `Jwts::Issuers::ForApiClients.new(name: 'FLIMPER-BACK', authorization_token: 'FLIMPER-BACK-AUTHORIZATION-TOKEN').issue!`
+
+- Issue a User jwt:
+
+  `Jwts::Issuers::ForUsers.new(email: 'test@test.com', password: 'password').issue!`
+
+- Check ApiClient permission:
+
+  `Permissions::Checkers::ForApiClients.new(jwt_token: 'valid_jwt', name: 'FLIMPER-BACK', resource_code: 'TWITTER_API_BACKEND', level: 'READ').can_perform_action?`
+
+- Check User permission:
+
+  `Permissions::Checkers::ForUsers.new(jwt_token: 'valid_jwt', email: 'email-1@gmail.com', resource_code: 'application-1', level: 'READ').can_perform_action?`
 
 ## Development
 

data/flimper_poncho.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.66.0'
+  spec.add_development_dependency 'vcr', '~> 4.0'
   spec.add_development_dependency 'webmock', '~> 3.5.1'
 
-  spec.add_dependency 'active_interaction', '~> 3.7'
   spec.add_dependency 'faraday', '~> 0.15.4'
   spec.add_dependency 'jwt', '~> 2.1'
 end

data/lib/flimper_poncho/jwts/issuers/for_api_clients.rb

@@ -0,0 +1,20 @@
+require 'flimper_poncho/jwts/issuers/template'
+
+module Jwts
+  module Issuers
+    class ForApiClients < Jwts::Issuers::Template
+      def initialize(name:, authorization_token:)
+        @name = name
+        @authorization_token = authorization_token
+      end
+
+      def poncho_api_endpoint
+        "#{ENV.fetch('PONCHO_API_URL')}/api_clients/jwt_tokens.json"
+      end
+
+      def security_data
+        { name: @name, authorization_token: @authorization_token }.to_json
+      end
+    end
+  end
+end

data/lib/flimper_poncho/jwts/issuers/for_users.rb

@@ -0,0 +1,20 @@
+require 'flimper_poncho/jwts/issuers/template'
+
+module Jwts
+  module Issuers
+    class ForUsers < Jwts::Issuers::Template
+      def initialize(email:, password:)
+        @email = email
+        @password = password
+      end
+
+      def poncho_api_endpoint
+        "#{ENV.fetch('PONCHO_API_URL')}/users/jwt_tokens.json"
+      end
+
+      def security_data
+        { email: @email, password: @password }.to_json
+      end
+    end
+  end
+end

data/lib/flimper_poncho/jwts/issuers/template.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'json'
+
+module Jwts
+  module Issuers
+    class Template
+      def issue!
+        poncho_response = Faraday.new.post do |request|
+          request.url(poncho_api_endpoint)
+          request.headers['Content-Type'] = 'application/json'
+          request.body = security_data
+        end
+
+        return unless poncho_response.success?
+
+        JSON.parse(poncho_response.body).dig('jwt_token')
+      end
+
+      private
+
+      def poncho_api_endpoint
+        raise NotImplementedError
+      end
+
+      def security_data
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/flimper_poncho/permissions/checkers/for_api_clients.rb

@@ -0,0 +1,20 @@
+require 'flimper_poncho/permissions/checkers/template'
+
+module Permissions
+  module Checkers
+    class ForApiClients < Permissions::Checkers::Template
+      attr_reader :jwt_token
+
+      def initialize(jwt_token:, resource_code:, level:, name:)
+        @jwt_token = jwt_token
+        @resource_code = resource_code
+        @level = level
+        @name = name
+      end
+
+      def permission_query
+        { 'name' => @name, 'resource_code' => @resource_code, 'level' => @level }
+      end
+    end
+  end
+end

data/lib/flimper_poncho/permissions/checkers/for_users.rb

@@ -0,0 +1,20 @@
+require 'flimper_poncho/permissions/checkers/template'
+
+module Permissions
+  module Checkers
+    class ForUsers < Permissions::Checkers::Template
+      attr_reader :jwt_token
+
+      def initialize(jwt_token:, resource_code:, level:, email:)
+        @jwt_token = jwt_token
+        @resource_code = resource_code
+        @level = level
+        @email = email
+      end
+
+      def permission_query
+        { 'email' => @email, 'resource_code' => @resource_code, 'level' => @level }
+      end
+    end
+  end
+end

data/lib/flimper_poncho/permissions/checkers/template.rb

@@ -0,0 +1,31 @@
+require 'jwt'
+
+module Permissions
+  module Checkers
+    class Template
+      def can_perform_action?
+        permissions.include?(permission_query) || permissions.include?(permission_query.merge('level' => 'ADMIN'))
+      rescue JWT::DecodeError
+        false
+      end
+
+      private
+
+      def permissions
+        decoded_jwt.dig('permissions') || []
+      end
+
+      def decoded_jwt
+        JWT.decode(jwt_token, ENV.fetch('PONCHO_API_SIGNATURE_KEY'), true, algorithm: 'HS256')[0]
+      end
+
+      def permission_query
+        raise NotImplementedError
+      end
+
+      def jwt_token
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/flimper_poncho/version.rb

@@ -1,3 +1,3 @@
 module FlimperPoncho
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/flimper_poncho.rb

@@ -1,5 +1,8 @@
 require 'flimper_poncho/version'
-require 'flimper_poncho/user_session/create'
+require 'flimper_poncho/jwts/issuers/for_api_clients'
+require 'flimper_poncho/jwts/issuers/for_users'
+require 'flimper_poncho/permissions/checkers/for_api_clients'
+require 'flimper_poncho/permissions/checkers/for_users'
 
 module FlimperPoncho
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flimper_poncho
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pablo Gonzaga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2019-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.66.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: active_interaction
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :runtime
+        version: 3.5.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +157,12 @@ files:
 - bin/setup
 - flimper_poncho.gemspec
 - lib/flimper_poncho.rb
-- lib/flimper_poncho/entities/user_session.rb
-- lib/flimper_poncho/user_session/create.rb
+- lib/flimper_poncho/jwts/issuers/for_api_clients.rb
+- lib/flimper_poncho/jwts/issuers/for_users.rb
+- lib/flimper_poncho/jwts/issuers/template.rb
+- lib/flimper_poncho/permissions/checkers/for_api_clients.rb
+- lib/flimper_poncho/permissions/checkers/for_users.rb
+- lib/flimper_poncho/permissions/checkers/template.rb
 - lib/flimper_poncho/version.rb
 homepage: https://github.com/flimperapp/poncho_gem
 licenses:

data/lib/flimper_poncho/entities/user_session.rb

@@ -1,26 +0,0 @@
-require 'jwt'
-
-module FlimperPoncho
-  module Entities
-    class UserSession
-      attr_reader :email, :authorization_token, :permissions
-
-      def initialize(jwt:)
-        @jwt = jwt
-        @authorization_token = jwt_decode.dig('authorization_token')
-        @email = jwt_decode.dig('email')
-
-        @permissions = jwt_decode.dig('permissions').map do |permission|
-          { email: permission.dig('email'), resource_code: permission.dig('resource_code'),
-            level: permission.dig('level') }
-        end
-      end
-
-      private
-
-      def jwt_decode
-        @jwt_decode ||= JWT.decode(@jwt, ENV.fetch('PONCHO_API_SIGNATURE_KEY'), true, algorithm: 'HS256')[0]
-      end
-    end
-  end
-end

data/lib/flimper_poncho/user_session/create.rb

@@ -1,39 +0,0 @@
-require 'active_interaction'
-require 'faraday'
-require 'json'
-require 'flimper_poncho/entities/user_session'
-
-module FlimperPoncho
-  module UserSession
-    class Create < ActiveInteraction::Base
-      string :email
-      string :password
-
-      validates :email, :password, presence: true
-
-      def execute
-        poncho_response = faraday_connection.post do |request|
-          request.url(poncho_api_url)
-          request.headers['Content-Type'] = 'application/json'
-          request.body = { email: email, password: password }.to_json
-        end
-
-        return unless poncho_response.success?
-
-        FlimperPoncho::Entities::UserSession.new(jwt: JSON.parse(poncho_response.body).dig('jwt_token'))
-      rescue KeyError => error
-        errors.add(:poncho_api_url, error.message)
-      end
-
-      private
-
-      def poncho_api_url
-        @poncho_api_url ||= "#{ENV.fetch('PONCHO_API_URL')}/user_sessions"
-      end
-
-      def faraday_connection
-        @faraday_connection ||= Faraday.new
-      end
-    end
-  end
-end