authentication setup, App-Worker resource and webmock (#3)

* authentication setup and also added App-Worker resource

* Update README.md

Author: inderps

.rubocop.yml

@@ -110,3 +110,9 @@ RSpec/FilePath:
 
 Style/Documentation:
   Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

Gemfile

@@ -7,6 +7,8 @@ gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 
 group :development do
+  gem 'pry'
   gem 'rubocop', require: false
   gem 'rubocop-rspec'
+  gem 'webmock'
 end

Gemfile.lock

@@ -2,15 +2,53 @@ PATH
   remote: .
   specs:
     cirro-ruby-client (0.1.0)
+      json_api_client
+      jwt
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    crack (0.4.4)
     diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json_api_client (1.17.1)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      addressable (~> 2.2)
+      faraday (>= 0.15.2, < 1.2.0)
+      faraday_middleware (>= 0.9.0, < 1.2.0)
+      rack (>= 0.2)
+    jwt (2.2.2)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
     parallel (1.19.2)
     parser (2.7.2.0)
       ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (12.3.3)
     regexp_parser (1.8.1)
@@ -42,17 +80,27 @@ GEM
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   cirro-ruby-client!
+  pry
   rake (~> 12.0)
   rspec (~> 3.0)
   rubocop
   rubocop-rspec
+  webmock
 
 BUNDLED WITH
    2.1.4

README.md

@@ -19,6 +19,19 @@ Or install it yourself as:
     $ gem install cirro-ruby-client
 
 
+## Configuration
+
+  You need to create an initializer file in config/initializers.
+
+  ```ruby
+  CirroIO::Client.configure do |c|
+    c.app_id 'WULnc6Y0rlaTBCSiHAb0kGWKFuIxPWBXJysyZeG3Rtw'
+    c.private_key_path './storage/cirro.pem'
+    c.site 'https://api.staging.cirro.io'
+  end
+  ```
+
+
 ## Development
 
 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.

cirro-ruby-client.gemspec

@@ -24,4 +24,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'jwt'
+  spec.add_runtime_dependency 'json_api_client'
 end

lib/cirro_io/client.rb

@@ -1,8 +1,22 @@
+require 'json_api_client'
 require 'cirro_io/client/version'
+require 'cirro_io/client/configuration'
+require 'cirro_io/client/response_debugging_middleware'
+require 'cirro_io/client/jwt_authentication'
+require 'cirro_io/client/base'
+require 'cirro_io/client/app_worker'
 
 module CirroIO
   module Client
     class Error < StandardError; end
-    # Your code goes here...
+
+    def self.configure
+      yield configuration if block_given?
+      Base.site = "#{configuration.site}/#{configuration.api_version}"
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
   end
 end

lib/cirro_io/client/app_worker.rb

@@ -0,0 +1,9 @@
+module CirroIO
+  module Client
+    class AppWorker < Base
+      def self.resource_name
+        'app-workers'
+      end
+    end
+  end
+end

lib/cirro_io/client/base.rb

@@ -0,0 +1,20 @@
+module CirroIO
+  module Client
+    class Base < JsonApiClient::Resource
+      self.route_format = :dasherized_route
+      self.json_key_format = :dasherized_key
+
+      # https://github.com/JsonApiClient/json_api_client/issues/215
+      def self.site=(url)
+        super(url)
+        connection.faraday.url_prefix = url
+      end
+    end
+  end
+end
+
+CirroIO::Client::Base.connection do |connection|
+  connection.use CirroIO::Client::JwtAuthentication
+  connection.use Faraday::Response::Logger
+  # connection.use CirroIO::Client::ResponseDebuggingMiddleware # This middleware can be injected during debugging or while adding new specs
+end

lib/cirro_io/client/configuration.rb

@@ -14,6 +14,17 @@ def private_key_path(value = nil)
 
         @private_key_path
       end
+
+      def site(value = nil)
+        @site = value unless value.nil?
+        raise 'site must be defined' unless defined?(@site)
+
+        @site
+      end
+
+      def api_version
+        'v1'
+      end
     end
   end
 end

lib/cirro_io/client/jwt_authentication.rb

@@ -0,0 +1,25 @@
+require 'jwt'
+require 'openssl'
+
+module CirroIO
+  module Client
+    class JwtAuthentication < Faraday::Middleware
+      def call(env)
+        private_pem = File.read(CirroIO::Client.configuration.private_key_path)
+        private_key = OpenSSL::PKey::RSA.new(private_pem)
+
+        payload = {
+          # JWT expiration time (10 minute maximum)
+          exp: Time.now.to_i + (10 * 60),
+          # App client id
+          iss: CirroIO::Client.configuration.app_id,
+        }
+
+        token = JWT.encode(payload, private_key, 'RS256')
+
+        env[:request_headers]['Authorization'] = "Bearer #{token}"
+        @app.call(env)
+      end
+    end
+  end
+end