amorail 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ad5de495defa31c023d17cb5733c2d51e56f4dd08b348e8259ee80986ec6c12
-  data.tar.gz: 2682594dd0d1c3661497b4712ad5751b9b7f7e2b67aa9f472151881ad8410e29
+  metadata.gz: 3b18605e272eb7a0c72af69e2d017f54753ff715d474d79cc9071791a036cd6d
+  data.tar.gz: d77fee259b877786fd18a044aaa52aff432be6936834095b5d8ab2d857d0df11
 SHA512:
-  metadata.gz: '089d26d7753c6b30108b65f119fa615e1ce3e7fad256ef4f4893d0737f9dcdcc4e5eabc42d49b75bb86c9dccc0ad5d8fe06779f0140d65450ddb58810b4998eb'
-  data.tar.gz: ff5cc0582d9bc552886efeb5bcb6fd0aa53a7ca930a682d1fba846719fc3be068966ea77103f5c20590c9f5597397f3cfe6518c02da6e7cf8220d5b3247adae6
+  metadata.gz: ab1e1221b40f406909ed76f4b444b7f7f7805d8f04c1e386030563471172175149ff718438bb4ee97d9bee28f2a3d9b9a78733828f8ab2d7b62edca6f631f56e
+  data.tar.gz: 4034fbcc9fea9004e159e62ac910ce9bfbe301ea76013f7d62d05a26cae8df2084c2836a4e4c65707cc4451fc8380fc163c5afe580068bdb8c4a40f79f632ff3

data/.github/workflows/rspec.yml

@@ -0,0 +1,23 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.5
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          bundler: 1.13.6
+      - name: Build and test
+        run: bundle exec rspec

data/.gitignore

@@ -12,4 +12,5 @@
 *.o
 *.a
 mkmf.log
-*.gem
+*.gem
+.idea

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change log
+
+## master (unreleased)
+
+## 0.7.0 (2021-07-16)
+
+### Features
+
+- Introduce [#53](https://github.com/teachbase/amorail/issues/48) Implement OAuth authentication ([@lHydra][])
+
+### Changes
+
+- increased ruby version to >= 2.5.0
+- updates dependencies versions
+
+
+[@palkan]: https://github.com/palkan
+[@AlexanderShvaykin]: https://github.com/AlexanderShvaykin
+[@lHydra]: https://github.com/lHydra

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/amorail.svg)](https://rubygems.org/gems/amorail) [![Build Status](https://travis-ci.org/teachbase/amorail.svg?branch=master)](https://travis-ci.org/teachbase/amorail)
+[![Gem Version](https://badge.fury.io/rb/amorail.svg)](https://rubygems.org/gems/amorail) ![Build](https://github.com/teachbase/amorail/workflows/Build/badge.svg)
 
 # Amorail
 
@@ -25,12 +25,48 @@ Or install it yourself as:
 With Amorail you can manipulate the following AmoCRM entities: Companies, Contacts, Leads and Tasks.
 We're triying to build simple AR-like interface.
 
+### Store configuration
+
+In order to configure a token store you should set up a store adapter in a following way: `Amorail.token_store = :redis, { redis_url: 'redis://127.0.0.1:6379/0' }` (options can be omitted). Currently supported stores are `:redis` and `:memory`. Memory adapter is used **by default**.
+
+Here is a default configuration for Redis:
+
+```ruby
+Amorail.token_store = :redis, {
+  redis_host: "127.0.0.1",
+  redis_port: "6379",
+  redis_db_name: "0"
+}
+```
+
+You can also provide a Redis URL instead:
+
+```ruby
+Amorail.token_store = :redis, { redis_url: "redis://localhost:6397" }
+```
+
+**NOTE**: if `REDIS_URL` environment variable is set it is used automatically.
+
+### Add custom store
+
+To add custom store you need declare a class that implements the interface `AbstractStoreAdapter`.
+For example `class FileStoreAdapter < Amorail::StoreAdapters::AbstractStoreAdapter`
+
+The class must contain constructor `initialize(**options)` and **4 required methods**:
+
+1. `fetch_access` — method that should return Hash with token data (**required keys:** `token`, `refresh_token` and `expiration`) or empty Hash (`{}`) if no value was received
+2. `persist_access` — method that stores data in storage
+3. `update_access` — method that updates existed token data in storage
+4. `access_expired?` — method that returns `true` if token was expired otherwise `false`
+
 ### Auth configuration
 
 Amorail uses [anyway_config](https://github.com/palkan/anyway_config) for configuration, so you
 can provide configuration parameters through env vars, seperate config file (`config/amorail.yml`) or `secrets.yml`.
 
-Required params: **usermail**, **api_key** and **api_endpoint**.
+Required params: **client_id**, **client_secret** **code**, **redirect_uri** and **api_endpoint**.
+
+An authorization **code** is required for the initial obtaining of a pair of access and refresh tokens. You can see it in the interface or through a Redirect URI if the authorization was run from the modal window for permissions. The lifespan of the code is 20 minutes. [More details](https://www.amocrm.com/developers/content/oauth/oauth/)
 
 Example:
 
@@ -39,9 +75,14 @@ Example:
 development:
   ...
   amorail:
-    usermail: 'amorail@test.com'
-    api_key: '75742b166417fe32ae132282ce178cf6'
-    api_endpoint: 'https://test.amocrm.ru'
+    client_id: c0df457d-eacc-47cc-behb-3d8f962g4lbf
+    client_secret: a36b564b64398d3e53004c12e4997eb340e32b18ee185389ddb409292ebc5ebae297a3eab96be4a9d38ecbf274d90bbb54a7e8f282f40d1b29e5c9b2e2e357a6
+    code: a911ff963f58ea6c846901056114d37a14d2efa4d05ffb6ef0a8d60d32e5d6dae785bd317cbc9b0bd04261cb0cf9905af0cc32b5567c1eb84433328d08888f5c613608b822c1928272769ffd284b
+    redirect_uri: https://example.ru
+    api_endpoint: https://test.amocrm.ru
+    redis_host: 127.0.0.1
+    redis_port: 6379
+    redis_db_name: 0
 ```
 
 ### Running from console
@@ -50,7 +91,7 @@ You can try amorail in action from console ([PRY](https://github.com/pry/pry) is
 
 ```shell
 # amorail gem directory
-AMORAIL_USERMAIL=my_mail@test.com AMORAIL_API_KEY=my_key AMORAIL_API_ENDPOINT=my@amo.com bundle exec rake console
+AMORAIL_CLIENT_ID=integration_id AMORAIL_CLIENT_SECRET=secret_key AMORAIL_CODE=my_code AMORAIL_REDIRECT_URI=https://example.com AMORAIL_API_ENDPOINT=https://test.amocrm.ru bundle exec rake console
 pry> Amorail.properties
 # ... prints properties (custom_fields) data
 pry> Amorail::Contact.find_by_query("test_contact")
@@ -223,12 +264,12 @@ It is possible to use Amorail with multiple AmoCRM accounts. To do so use `Amora
 which receive client params or client instance and a block to execute within custom context:
 
 ```ruby
-Amorail.with_client(usermail: "custom@mail.com", api_endpoint: "https://my.acmocrm.ru", api_key: "my_secret_key") do
+Amorail.with_client(client_id: "my_id", client_secret: "my_secret", code: "my_code", api_endpoint: "https://my.acmocrm.ru", redirect_uri: "https://example.com") do
   # Client specific code here
 end
 
 # or using client instance
-my_client = Amorail::Client.new(usermail: "custom@mail.com", api_endpoint: "https://my.acmocrm.ru", api_key: "my_secret_key")
+my_client = Amorail::Client.new(client_id: "my_id", client_secret: "my_secret", code: "my_code", api_endpoint: "https://my.acmocrm.ru", redirect_uri: "https://example.com")
 
 Amorail.with_client(client) do
   ...

data/RELEASING.md

@@ -0,0 +1,43 @@
+# How to release a gem
+
+This document describes a process of releasing a new version of a gem.
+
+1. Bump version.
+
+```sh
+git commit -m "Bump 1.<x>.<y>"
+```
+
+We're (kinda) using semantic versioning:
+
+- Bugfixes should be released as fast as possible as patch versions.
+- New features could be combined and released as minor or patch version upgrades (depending on the _size of the feature_—it's up to maintainers to decide).
+- Breaking API changes should be avoided in minor and patch releases.
+- Breaking dependencies changes (e.g., dropping older Ruby support) could be released in minor versions.
+
+How to bump a version:
+
+- Change the version number in `lib/amorail/version.rb` file.
+- Update the changelog (add new heading with the version name and date).
+- Update the installation documentation if necessary (e.g., during minor and major updates).
+
+2. Push code to GitHub and make sure CI passes.
+
+```sh
+git push
+```
+
+3. Release a gem.
+
+```sh
+gem release -t
+git push --tags
+```
+
+We use [gem-release](https://github.com/svenfuchs/gem-release) for publishing gems with a single command:
+
+```sh
+gem release -t
+```
+
+Don't forget to push tags and write release notes on GitHub (if necessary).

data/amorail.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Ruby API client for AmoCRM. You can integrate your system with it.}
   spec.homepage      = ""
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -28,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "anyway_config", ">= 1.0"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
-  spec.add_dependency 'activemodel'
-  spec.add_dependency 'json'
+  spec.add_dependency "activemodel"
+  spec.add_dependency "json"
+  spec.add_dependency "redis"
 end

data/lib/amorail.rb

@@ -6,34 +6,38 @@ require 'amorail/client'
 require 'amorail/exceptions'
 require 'amorail/entity'
 require 'amorail/property'
+require 'amorail/access_token'
+require 'amorail/store_adapters'
 
 Gem.find_files('amorail/entities/*.rb').each { |path| require path }
 
 # AmoCRM API integration.
 # https://www.amocrm.com/
 module Amorail
-  def self.config
+  extend self
+
+  def config
     @config ||= Config.new
   end
 
-  def self.properties
+  def properties
     client.properties
   end
 
-  def self.configure
+  def configure
     yield(config) if block_given?
   end
 
-  def self.client
+  def client
     ClientRegistry.client || (@client ||= Client.new)
   end
 
-  def self.reset
+  def reset
     @config = nil
     @client = nil
   end
 
-  def self.with_client(client)
+  def with_client(client)
     client = Client.new(client) unless client.is_a?(Client)
     ClientRegistry.client = client
     yield
@@ -41,6 +45,21 @@ module Amorail
     ClientRegistry.client = nil
   end
 
+  def token_store=(args)
+    adapter, options = Array(args)
+    @token_store = StoreAdapters.build_by_name(adapter, options)
+  rescue NameError => e
+    raise e.class, "Token store adapter for :#{adapter} haven't been found", e.backtrace
+  end
+
+  def token_store
+    unless instance_variable_defined?(:@token_store)
+      self.token_store = :memory
+    end
+
+    @token_store
+  end
+
   class ClientRegistry # :nodoc:
     extend ActiveSupport::PerThreadRegistry
 

data/lib/amorail/access_token.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Amorail
+  class AccessToken
+    attr_reader :token, :secret, :expiration, :refresh_token, :store
+
+    def initialize(secret, token, refresh_token, expiration, store)
+      @secret        = secret
+      @token         = token
+      @refresh_token = refresh_token
+      @expiration    = expiration
+      @store         = store
+    end
+
+    def expired?
+      store.access_expired?(secret)
+    end
+
+    class << self
+      def create(secret, token, refresh_token, expiration, store)
+        new(secret, token, refresh_token, expiration, store).tap do |access_token|
+          store.persist_access(access_token.secret, access_token.token, access_token.refresh_token, access_token.expiration)
+        end
+      end
+
+      def find(secret, store)
+        token_attrs = store.fetch_access(secret)
+        build_with_token_attrs(store, secret, token_attrs)
+      end
+
+      def refresh(secret, token, refresh_token, expiration, store)
+        new(secret, token, refresh_token, expiration, store).tap do |access_token|
+          store.update_access(access_token.secret, access_token.token, access_token.refresh_token, access_token.expiration)
+        end
+      end
+
+      private
+
+      def build_with_token_attrs(store, secret, token_attrs)
+        new(secret, token_attrs[:token], token_attrs[:refresh_token], token_attrs[:expiration], store)
+      end
+    end
+  end
+end

data/lib/amorail/client.rb

@@ -10,14 +10,31 @@ module Amorail
   class Client
     SUCCESS_STATUS_CODES = [200, 204].freeze
 
-    attr_reader :usermail, :api_key, :api_endpoint
+    attr_accessor :store
+    attr_reader :api_endpoint,
+                :access_token,
+                :refresh_token,
+                :access,
+                :client_id,
+                :client_secret,
+                :code,
+                :redirect_uri
 
     def initialize(api_endpoint: Amorail.config.api_endpoint,
-                   api_key: Amorail.config.api_key,
-                   usermail: Amorail.config.usermail)
+                   client_id: Amorail.config.client_id,
+                   client_secret: Amorail.config.client_secret,
+                   code: Amorail.config.code,
+                   redirect_uri: Amorail.config.redirect_uri)
+      @store = Amorail.token_store
       @api_endpoint = api_endpoint
-      @api_key = api_key
-      @usermail = usermail
+      @client_id = client_id
+      @client_secret = client_secret
+      @code = code
+      @redirect_uri = redirect_uri
+      @access = AccessToken.find(@client_secret, store)
+      @access_token = @access.token
+      @refresh_token = @access.refresh_token
+
       @connect = Faraday.new(url: api_endpoint) do |faraday|
         faraday.response :json, content_type: /\bjson$/
         faraday.use :instrumentation
@@ -34,33 +51,53 @@ module Amorail
     end
 
     def authorize
-      self.cookies = nil
-      response = post(
-        Amorail.config.auth_url,
-        'USER_LOGIN' => usermail,
-        'USER_HASH' => api_key
-      )
-      cookie_handler(response)
+      response = post(Amorail.config.auth_url, auth_params)
+      create_access_token(response)
+      response
+    end
+
+    def refresh_token!
+      response = post(Amorail.config.auth_url, refresh_params)
+      update_access_token(response)
       response
     end
 
+    def auth_params
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: 'authorization_code',
+        code: @code,
+        redirect_uri: redirect_uri
+      }
+    end
+
+    def refresh_params
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: 'refresh_token',
+        refresh_token: refresh_token,
+        redirect_uri: redirect_uri
+      }
+    end
+
     def safe_request(method, url, params = {})
-      public_send(method, url, params)
-    rescue ::Amorail::AmoUnauthorizedError
-      authorize
+      authorize if access_token.blank?
+      refresh_token! if access.expired?
       public_send(method, url, params)
     end
 
     def get(url, params = {})
       response = connect.get(url, params) do |request|
-        request.headers['Cookie'] = cookies if cookies.present?
+        request.headers['Authorization'] = "Bearer #{access_token}" if access_token.present?
       end
       handle_response(response)
     end
 
     def post(url, params = {})
       response = connect.post(url) do |request|
-        request.headers['Cookie'] = cookies if cookies.present?
+        request.headers['Authorization'] = "Bearer #{access_token}" if access_token.present?
         request.headers['Content-Type'] = 'application/json'
         request.body = params.to_json
       end
@@ -69,12 +106,6 @@ module Amorail
 
     private
 
-    attr_accessor :cookies
-
-    def cookie_handler(response)
-      self.cookies = response.headers['set-cookie'].split('; ')[0]
-    end
-
     def handle_response(response) # rubocop:disable all
       return response if SUCCESS_STATUS_CODES.include?(response.status)
 
@@ -99,5 +130,33 @@ module Amorail
         fail ::Amorail::AmoUnknownError, response.body
       end
     end
+
+    def create_access_token(response)
+      _access = AccessToken.create(
+        client_secret,
+        response.body['access_token'],
+        response.body['refresh_token'],
+        expiration(response.body['expires_in']),
+        store
+      )
+      @access_token = _access.token
+      @refresh_token = _access.refresh_token
+    end
+
+    def update_access_token(response)
+      _access = AccessToken.refresh(
+        client_secret,
+        response.body['access_token'],
+        response.body['refresh_token'],
+        expiration(response.body['expires_in']),
+        store
+      )
+      @access_token = _access.token
+      @refresh_token = _access.refresh_token
+    end
+
+    def expiration(expires_in)
+      Time.now.to_i + expires_in.to_i
+    end
   end
 end

data/lib/amorail/config.rb

@@ -4,16 +4,20 @@ require 'anyway'
 
 module Amorail
   # Amorail config contains:
-  # - usermail ("user@gmail.com")
-  # - api_key ("13601bbac84727df")
   # - api_endpoint ("http://you_company.amocrm.com")
   # - api_path (default: "/private/api/v2/json/")
-  # - auth_url (default: "/private/api/auth.php?type=json")
+  # - auth_url (default: "/oauth2/access_token")
   class Config < Anyway::Config
-    attr_config :usermail,
-                :api_key,
-                :api_endpoint,
-                api_path: "/private/api/v2/json/",
-                auth_url: "/private/api/auth.php?type=json"
+    attr_config :api_endpoint,
+                :client_id,
+                :client_secret,
+                :code,
+                :redirect_uri,
+                :redis_url,
+                api_path: '/private/api/v2/json/',
+                auth_url: '/oauth2/access_token',
+                redis_host: '127.0.0.1',
+                redis_port: '6379',
+                redis_db_name: '0'
   end
 end

data/lib/amorail/store_adapters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'amorail/store_adapters/abstract_store_adapter'
+require 'amorail/store_adapters/redis_store_adapter'
+require 'amorail/store_adapters/memory_store_adapter'
+
+module Amorail
+  module StoreAdapters
+    def self.build_by_name(adapter, options = nil)
+      camelized_adapter = adapter.to_s.split('_').map(&:capitalize).join
+      adapter_class_name = "#{camelized_adapter}StoreAdapter"
+      StoreAdapters.const_get(adapter_class_name).new(**(options || {}))
+    end
+  end
+end

data/lib/amorail/store_adapters/abstract_store_adapter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Amorail
+  module StoreAdapters
+    class AbstractStoreAdapter
+      def fetch_access(_secret)
+        raise NotImplementedError
+      end
+
+      def persist_access(_secret, _token, _refresh_token, _expiration)
+        raise NotImplementedError
+      end
+
+      def update_refresh(_secret, _token, _refresh_token, _expiration)
+        raise NotImplementedError
+      end
+
+      def access_expired?(_key)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/amorail/store_adapters/memory_store_adapter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Amorail
+  module StoreAdapters
+    class MemoryStoreAdapter < AbstractStoreAdapter
+      attr_reader :storage
+
+      def initialize(**options)
+        raise ArgumentError, 'Memory store doesn\'t support any options' if options.any?
+        @storage = Hash.new { |hh, kk| hh[kk] = {} }
+      end
+
+      def fetch_access(secret)
+        value_if_not_expired(secret)
+      end
+
+      def persist_access(secret, token, refresh_token, expiration)
+        access_token = { token: token, refresh_token: refresh_token, expiration: expiration }
+        storage.store(secret, access_token)
+      end
+
+      def update_access(secret, token, refresh_token, expiration)
+        update_access_fields(
+          secret,
+          token: token,
+          refresh_token: refresh_token,
+          expiration: expiration
+        )
+      end
+
+      def access_expired?(key)
+        storage[key][:expiration] && Time.now.to_i >= storage[key][:expiration]
+      end
+
+      private
+
+      def value_if_not_expired(key)
+        if !access_expired?(key)
+          storage[key]
+        else
+          {}
+        end
+      end
+
+      def update_access_fields(key, fields)
+        storage[key].merge!(fields)
+      end
+    end
+  end
+end

data/lib/amorail/store_adapters/redis_store_adapter.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Amorail
+  module StoreAdapters
+    class RedisStoreAdapter < AbstractStoreAdapter
+      attr_reader :storage
+
+      def initialize(**options)
+        begin
+          require 'redis'
+          @storage = configure_redis_client(**options)
+        rescue LoadError => e
+          msg = 'Could not load the \'redis\' gem, please add it to your gemfile or ' \
+                'configure a different adapter (e.g. Amorail.store_adapter = :memory)'
+          raise e.class, msg, e.backtrace
+        end
+      end
+
+      def fetch_access(secret)
+        token = storage.get(access_key(secret))
+        refresh_token = storage.get(refresh_key(secret))
+        token.nil? ? {} : { token: token, refresh_token: refresh_token }
+      end
+
+      def persist_access(secret, token, refresh_token, expiration)
+        update_data(secret, token, refresh_token, expiration)
+      end
+
+      def update_access(secret, token, refresh_token, expiration)
+        update_data(secret, token, refresh_token, expiration)
+      end
+
+      def access_expired?(secret)
+        access_key = access_key(secret)
+        refresh_key = refresh_key(secret)
+        storage.get(refresh_key) && storage.get(access_key).nil?
+      end
+
+      private
+
+      def update_data(secret, token, refresh_token, expiration)
+        access_key = access_key(secret)
+        refresh_key = refresh_key(secret)
+        storage.set(access_key, token)
+        storage.set(refresh_key, refresh_token)
+        storage.expireat(access_key, expiration)
+      end
+
+      def configure_redis_client(redis_url: nil, redis_host: nil, redis_port: nil, redis_db_name: nil)
+        if redis_url && (redis_host || redis_port || redis_db_name)
+          raise ArgumentError, 'redis_url cannot be passed along with redis_host, redis_port or redis_db_name options'
+        end
+
+        redis_url ||= build_redis_url(
+          redis_host: redis_host,
+          redis_port: redis_port,
+          redis_db_name: redis_db_name
+        )
+
+        Redis.new(url: redis_url)
+      end
+
+      def build_redis_url(redis_host: nil, redis_port: nil, redis_db_name: nil)
+        redis_db_name ||= Amorail.config.redis_db_name
+        return URI.join(Amorail.config.redis_url, redis_db_name).to_s if Amorail.config.redis_url
+
+        redis_host ||= Amorail.config.redis_host
+        redis_port ||= Amorail.config.redis_port
+
+        redis_base_url = ENV['REDIS_URL'] || "redis://#{redis_host}:#{redis_port}"
+        URI.join(redis_base_url, redis_db_name).to_s
+      end
+
+      def access_key(secret)
+        "access_#{secret}"
+      end
+
+      def refresh_key(secret)
+        "refresh_#{secret}"
+      end
+    end
+  end
+end

data/lib/amorail/version.rb

@@ -2,5 +2,5 @@
 
 # Amorail version
 module Amorail
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/spec/access_token_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Amorail::AccessToken do
+  let(:store) { Amorail.token_store }
+
+  before do
+    Amorail::AccessToken.create(
+      'secret',
+      'token',
+      'refresh_token',
+      Time.now.to_i + 86_000,
+      store
+    )
+
+    Amorail::AccessToken.create(
+      'secret_expired',
+      'token',
+      'refresh_token',
+      Time.now.to_i - 92_000,
+      store
+    )
+  end
+
+  describe '#find' do
+    context 'when token is not expired' do
+      subject { Amorail::AccessToken.find('secret', store).token }
+
+      it 'should return token' do
+        expect(subject).to eq('token')
+      end
+    end
+
+    context 'when token is expired' do
+      subject { Amorail::AccessToken.find('secret_expired', store).token }
+
+      it 'should return nil' do
+        expect(subject).to be_nil
+      end
+    end
+  end
+
+  describe '#refresh' do
+    it 'updates token data' do
+      upd_expiration = Time.now.to_i + 96_000
+      access_token = Amorail::AccessToken.refresh('secret',
+                                                  'upd_token',
+                                                  'upd_refresh',
+                                                  upd_expiration,
+                                                  Amorail.token_store)
+      aggregate_failures do
+        expect(access_token.token).to eq('upd_token')
+        expect(access_token.refresh_token).to eq('upd_refresh')
+        expect(access_token.expiration).to eq(upd_expiration)
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -9,8 +9,10 @@ describe Amorail::Client do
 
   context "default client" do
     it "should create client", :aggregate_failures do
-      expect(subject.usermail).to eq "amorail@test.com"
-      expect(subject.api_key).to eq "75742b166417fe32ae132282ce178cf6"
+      expect(subject.client_id).to eq "some_id"
+      expect(subject.client_secret).to eq "some_secret"
+      expect(subject.code).to eq "some_code"
+      expect(subject.redirect_uri).to eq "https://example.ru/redirect/uri"
       expect(subject.api_endpoint).to eq "https://test.amocrm.ru"
     end
 
@@ -26,40 +28,48 @@ describe Amorail::Client do
   end
 
   describe "#with_client" do
-    before { mock_custom_api("https://custom.amo.com", "custom@amo.com", "123") }
+    before { mock_custom_api("https://custom.amo.com", "custom_client_id", "custom_client_secret", "custom_code", "https://custom-site.ru/redirecto/uri") }
 
     let(:new_client) do
       described_class.new(
         api_endpoint: "https://custom.amo.com",
-        usermail: "custom@amo.com",
-        api_key: "123"
+        client_secret: "custom_client_secret",
+        client_id: "custom_client_id",
+        code: "custom_code",
+        redirect_uri: "https://custom-site.ru/redirecto/uri"
       )
     end
 
     it "use custom client as instance", :aggregate_failures do
-      expect(Amorail.client.usermail).to eq "amorail@test.com"
+      expect(Amorail.client.client_id).to eq "some_id"
       Amorail.with_client(new_client) do
-        expect(Amorail.client.usermail).to eq "custom@amo.com"
+        expect(Amorail.client.client_secret).to eq "custom_client_secret"
+        expect(Amorail.client.client_id).to eq "custom_client_id"
         expect(Amorail.client.api_endpoint).to eq "https://custom.amo.com"
-        expect(Amorail.client.api_key).to eq "123"
+        expect(Amorail.client.code).to eq "custom_code"
+        expect(Amorail.client.redirect_uri).to eq "https://custom-site.ru/redirecto/uri"
       end
 
-      expect(Amorail.client.usermail).to eq "amorail@test.com"
+      expect(Amorail.client.client_id).to eq "some_id"
     end
 
     it "use custom client as options", :aggregate_failures do
-      expect(Amorail.client.usermail).to eq "amorail@test.com"
+      expect(Amorail.client.client_id).to eq "some_id"
       Amorail.with_client(
         api_endpoint: "https://custom.amo.com",
-        usermail: "custom@amo.com",
-        api_key: "123"
+        client_secret: "custom_client_secret",
+        client_id: "custom_client_id",
+        code: "custom_code",
+        redirect_uri: "https://custom-site.ru/redirecto/uri"
       ) do
-        expect(Amorail.client.usermail).to eq "custom@amo.com"
+        expect(Amorail.client.client_secret).to eq "custom_client_secret"
+        expect(Amorail.client.client_id).to eq "custom_client_id"
         expect(Amorail.client.api_endpoint).to eq "https://custom.amo.com"
-        expect(Amorail.client.api_key).to eq "123"
+        expect(Amorail.client.code).to eq "custom_code"
+        expect(Amorail.client.redirect_uri).to eq "https://custom-site.ru/redirecto/uri"
       end
 
-      expect(Amorail.client.usermail).to eq "amorail@test.com"
+      expect(Amorail.client.client_id).to eq "some_id"
     end
 
     it "loads custom properties", :aggregate_failures do
@@ -83,10 +93,10 @@ describe Amorail::Client do
       # only after the second thread enters block
       threads << Thread.new do
         q1.pop
-        Amorail.with_client(usermail: 'test1@amo.com') do
+        Amorail.with_client(client_id: 'some_id_1') do
           q2 << 1
           q1.pop
-          results << Amorail.client.usermail
+          results << Amorail.client.client_id
           q2 << 1
         end
         q3 << 1
@@ -96,10 +106,10 @@ describe Amorail::Client do
       # after the first block
       threads << Thread.new do
         q2.pop
-        Amorail.with_client(usermail: 'test2@amo.com') do
+        Amorail.with_client(client_id: 'some_id_2') do
           q1 << 1
           q2.pop
-          results << Amorail.client.usermail
+          results << Amorail.client.client_id
         end
         q3 << 1
       end
@@ -107,19 +117,19 @@ describe Amorail::Client do
       # This thread enters block third and commits
       # after all other threads left blocks
       threads << Thread.new do
-        Amorail.with_client(usermail: 'test3@amo.com') do
+        Amorail.with_client(client_id: 'some_id_3') do
           q3.pop
           q3.pop
-          results << Amorail.client.usermail
+          results << Amorail.client.client_id
         end
       end
 
       q1 << 1
       threads.each(&:join)
 
-      expect(results[0]).to eq 'test1@amo.com'
-      expect(results[1]).to eq 'test2@amo.com'
-      expect(results[2]).to eq 'test3@amo.com'
+      expect(results[0]).to eq 'some_id_1'
+      expect(results[1]).to eq 'some_id_2'
+      expect(results[2]).to eq 'some_id_3'
     end
   end
 end

data/spec/fixtures/amorail_test.yml

@@ -1,3 +1,5 @@
-usermail: 'amorail@test.com'
-api_key: '75742b166417fe32ae132282ce178cf6'
-api_endpoint: 'https://test.amocrm.ru'
+client_id: 'some_id'
+client_secret: 'some_secret'
+code: 'some_code'
+redirect_uri: 'https://example.ru/redirect/uri'
+api_endpoint: 'https://test.amocrm.ru'

data/spec/fixtures/authorize.json

@@ -0,0 +1,6 @@
+{
+  "token_type": "Bearer",
+  "expires_in": 86400,
+  "access_token": "eyJ0eXAiOiJKf2QihCJhbGciOiJSUzI1NiIsImp0aSI6IjMxMTY3MGY3ZDVjY2IwODRjYTUyOTc5OGVjMzM0ZGU2ZDIzMmYzZDUyMjE0NTFhMTYzZDFlMTM2ZGY3NjA4MGVmMjViZTMwODQwNzFhY2Y0In0.eyJhdWQiOiIwNDA4M2FjZC1iY2ZmLTRiOWItOTJkYS05OTFiOTc0MDBlNzMiLCJqdGkiOiIzMTE2NzBmN2Q1Y2NiMDg0Y2E1Mjk3OThlYzMzNGRlNmQyMzJmM2Q1MjIxNDUxYTE2M2QxZTEzNmRmNzYwODBlZjI1YmUzMDg0MDcxYWNmNCIsImlhdCI6MTYxMzM4NzQ2MiwibmJmIDoxNjEzMzg3NDYyLCJleHAiOjE2MTM0NzM4NyIsInN1YiI6IjYyNjU1OTEiLCJhY2NvdW50X2lkIjoyOTAxMTIzMSwic2NvcGVzIjpbInB1c2hfbm90aWZpY2F0aW9ucyIsImNybSIsIm5vdGlmaWNhdGlvbnMiXX0.HRnJJXSK5KrlkcxHVBQBvE8TS34Rwru4Ba_lBlgzEtfU6FjaOCuBA0VLKJ24lLHz2w9B3lgMn9-OG9ayXAkDqrNPZByOimJ5cdwQExlNws-gvO9Hj27QiWK5JMTvbDE4EjVGvKuH7uXRsFTcsmuP6MA-5hjZ5h2DmNr5gzfZVS2Onh_9vrX75yh5FjFohfoO8izohtQYzZDVNYzek13EBdEK2BiNgLCoGhyGeMRtmTpwdSueD72qFGL80RMkQAGV8mElkZiXeUuGckTvEdIUodlgH6fk_KYG8OF3jozbEpzFKKfgPMUjE3vyCLVPWCEolQZjZPhSd6KbatK-f0oPWA",
+  "refresh_token": "def50200f4151ec4424843abc377eec488c6e8dceeda93b3f0b33d8f02207911533d98b408b97e2b2688acd1d956a44368f51263c7a55253efb543b256b90a2a1dc0ac71bf546374f23ab3d2b07f3ced5ad31e500e16b4d99deb6c735a5001c43c70156feac0a9c94dd24fdc6238ee59603997614ccb28773e4bce14d01e69fa7c04f869088fb1c9c27fea2f68f70E46d615a3982bdcd352Dcd05e3ae70e1d1ba707dcb354e7b611eba6790039a6c4bf2909210a85bdc34a254e9a10f8637aff405938ddcdc8bf88fb4ed8c8f15d7fa1e0e787c624b26c270b43e5877e1b6c87292bd95bb90305f50886b595d5a83c5b9768a8a61c63cdc7b082312ecc32619577253856058e8761c6f1e338e58824d8bed2a227bbe43dd12a69bf347657aa4f41f5d7609b6c5e088a0a0d2b2af9877bf8642c7d44fc6caa3c7dfa342d8b38e37d8a68dd26e814f0bfcdee707bf44ce7ef9e4d57ff5ac6aa52f2259388e5a3b7e5c6689366f43bf9197b2bf0e00470a3031581031b82ade8d8c0f8c01eabb61c312f47a2cfdc2943b10bc1f3d0b7791e1b1487832d3db75908611af90659f721cd3f831dcc76d8da12044611910722c9dc8bc09a5aff82923a2551a5bd5c5c57e4273993e655da7881e3"
+}

data/spec/helpers/webmock_helpers.rb

@@ -5,34 +5,69 @@ module AmoWebMock
   def mock_api
     authorize_stub(
       Amorail.config.api_endpoint,
-      Amorail.config.usermail,
-      Amorail.config.api_key)
+      Amorail.config.client_id,
+      Amorail.config.client_secret,
+      'authorization_code',
+      Amorail.config.code,
+      Amorail.config.redirect_uri
+    )
+
+    resresh_token_stub(
+      Amorail.config.api_endpoint,
+      Amorail.config.client_id,
+      Amorail.config.client_secret,
+      'refresh_token',
+      'refresh_token',
+      Amorail.config.redirect_uri
+    )
 
     account_info_stub(Amorail.config.api_endpoint)
   end
 
-  def mock_custom_api(endpoint, usermail, api_key, properties = 'response_2.json')
+  def mock_custom_api(endpoint, client_id, client_secret, code, redirect_uri, properties = 'response_2.json')
     authorize_stub(
       endpoint,
-      usermail,
-      api_key
+      client_id,
+      client_secret,
+      'authorization_code',
+      code,
+      redirect_uri
+    )
+
+    resresh_token_stub(
+      endpoint,
+      client_id,
+      client_secret,
+      'refresh_token',
+      'refresh_token',
+      redirect_uri
     )
 
     account_info_stub(endpoint, properties)
   end
 
-  def authorize_stub(endpoint, usermail, api_key)
-    cookie = 'PHPSESSID=58vorte6dd4t7h6mtuig9l0p50; path=/; domain=amocrm.ru'
-    stub_request(:post, "#{endpoint}/private/api/auth.php?type=json")
+  def authorize_stub(endpoint, client_id, client_secret, grant_type, code, redirect_uri)
+    stub_request(:post, "#{endpoint}/oauth2/access_token")
       .with(
-        body: "{\"USER_LOGIN\":\"#{usermail}\",\"USER_HASH\":\"#{api_key}\"}"
+        body: "{\"client_id\":\"#{client_id}\",\"client_secret\":\"#{client_secret}\",\"grant_type\":\"#{grant_type}\",\"code\":\"#{code}\",\"redirect_uri\":\"#{redirect_uri}\"}"
       )
       .to_return(
         status: 200,
-        body: "",
-        headers: {
-          'Set-Cookie' => cookie
-        })
+        body: File.read('./spec/fixtures/authorize.json'),
+        headers: {}
+      )
+  end
+
+  def resresh_token_stub(endpoint, client_id, client_secret, grant_type, refresh_token, redirect_uri)
+    stub_request(:post, "#{endpoint}/oauth2/access_token")
+        .with(
+            body: "{\"client_id\":\"#{client_id}\",\"client_secret\":\"#{client_secret}\",\"grant_type\":\"#{grant_type}\",\"refresh_token\":\"#{refresh_token}\",\"redirect_uri\":\"#{redirect_uri}\"}"
+        )
+        .to_return(
+            status: 200,
+            body: File.read('./spec/fixtures/authorize.json'),
+            headers: {}
+        )
   end
 
   def account_info_stub(endpoint, properties = 'response_1.json')

data/spec/store_adapters/memory_store_adapter_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Amorail::StoreAdapters::MemoryStoreAdapter do
+  let!(:expiration) { Time.now.to_i + 86_000 }
+  let(:store) { Amorail::StoreAdapters.build_by_name(:memory) }
+
+  describe '#initialize' do
+    it 'raises error on unknow option' do
+      expect { Amorail::StoreAdapters::MemoryStoreAdapter.new(something: 'something') }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#persist_access' do
+    subject { store.persist_access('secret', 'token', 'refresh_token', expiration) }
+
+    it 'save record to memory' do
+      expect { subject }.to change { store.fetch_access('secret') }.from(
+        {}
+      ).to(
+        { token: 'token', refresh_token: 'refresh_token', expiration: expiration }
+      )
+    end
+  end
+
+  describe '#fetch_access' do
+    context 'when token not expired' do
+      it 'returns valid data' do
+        store.persist_access('secret', 'token', 'refresh_token', expiration)
+        expect(store.fetch_access('secret')).to eq({ token: 'token', refresh_token: 'refresh_token', expiration: expiration })
+      end
+    end
+
+    context 'when token is expired' do
+      it 'returns blank hash' do
+        store.persist_access('secret', 'token', 'refresh_token', Time.now.to_i - 10_000)
+        expect(store.fetch_access('secret')).to eq({})
+      end
+    end
+  end
+
+  describe '#update_access' do
+    let!(:upd_expiration) { Time.now.to_i + 92_000 }
+    subject { store.update_access('secret', 'upd_token', 'upd_refresh', upd_expiration) }
+
+    it 'refresh token data' do
+      store.persist_access('secret', 'token', 'refresh_token', expiration)
+      expect { subject }.to change { store.fetch_access('secret') }.from(
+        { token: 'token', refresh_token: 'refresh_token', expiration: expiration }
+      ).to(
+        { token: 'upd_token', refresh_token: 'upd_refresh', expiration: upd_expiration }
+      )
+    end
+  end
+end

data/spec/store_adapters/redis_store_adapter_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Amorail::StoreAdapters::RedisStoreAdapter do
+  before :each do
+    Amorail.config.reload
+  end
+
+  let(:store) { Amorail::StoreAdapters.build_by_name(:redis) }
+
+  describe '#initialize' do
+    it 'raises error on mixed redis options' do
+      expect { Amorail::StoreAdapters::RedisStoreAdapter.new(redis_url: 'redis://127.0.0.1:6379/0',
+                                                             redis_port: '8082') }.to raise_error(ArgumentError)
+    end
+
+    it 'raises error on unknown options' do
+      expect { Amorail::StoreAdapters::RedisStoreAdapter.new(redis_url: 'redis://127.0.0.1:6379/0',
+                                                             something: 'smth') }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe 'configuration' do
+    let(:adapter) { Amorail::StoreAdapters::RedisStoreAdapter.new }
+
+    it 'set default url' do
+      expect(adapter.storage.id).to eq('redis://127.0.0.1:6379/0')
+    end
+
+    it 'set url from env variable' do
+      ENV['REDIS_URL'] = 'redis://localhost:2020/'
+      adapter = Amorail::StoreAdapters::RedisStoreAdapter.new
+      expect(adapter.storage.id).to eq('redis://localhost:2020/0')
+
+      ENV.delete('REDIS_URL')
+      adapter = Amorail::StoreAdapters::RedisStoreAdapter.new
+      expect(adapter.storage.id).to eq('redis://127.0.0.1:6379/0')
+    end
+
+    it 'configuration via host post and db' do
+      adapter = Amorail::StoreAdapters::RedisStoreAdapter.new(
+          redis_host: '127.0.0.2',
+          redis_port: '6372',
+          redis_db_name: '2'
+      )
+      expect(adapter.storage.id).to eq('redis://127.0.0.2:6372/2')
+    end
+
+    it 'configuration via host port and db in module' do
+      Amorail.config.redis_host = '127.0.0.2'
+      Amorail.config.redis_port = '6372'
+      Amorail.config.redis_db_name = '2'
+      expect(adapter.storage.id).to eq('redis://127.0.0.2:6372/2')
+    end
+
+    it 'configuration via redis url' do
+      adapter = Amorail::StoreAdapters::RedisStoreAdapter.new(redis_url: 'redis://127.0.0.2:6322')
+      expect(adapter.storage.id).to eq('redis://127.0.0.2:6322/0')
+    end
+
+    it 'configuration via redis url in module' do
+      Amorail.config.redis_url = 'redis://127.0.0.2:6322'
+      expect(adapter.storage.id).to eq('redis://127.0.0.2:6322/0')
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: amorail
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - alekseenkoss
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,6 +179,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby API client for AmoCRM. You can integrate your system with it.
 email:
 - alekseenkoss@gmail.com
@@ -187,15 +201,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - amorail.gemspec
 - lib/amorail.rb
+- lib/amorail/access_token.rb
 - lib/amorail/client.rb
 - lib/amorail/config.rb
 - lib/amorail/entities/company.rb
@@ -214,8 +231,13 @@ files:
 - lib/amorail/exceptions.rb
 - lib/amorail/property.rb
 - lib/amorail/railtie.rb
+- lib/amorail/store_adapters.rb
+- lib/amorail/store_adapters/abstract_store_adapter.rb
+- lib/amorail/store_adapters/memory_store_adapter.rb
+- lib/amorail/store_adapters/redis_store_adapter.rb
 - lib/amorail/version.rb
 - lib/tasks/amorail.rake
+- spec/access_token_spec.rb
 - spec/client_spec.rb
 - spec/company_spec.rb
 - spec/contact_link_spec.rb
@@ -224,6 +246,7 @@ files:
 - spec/fixtures/accounts/response_1.json
 - spec/fixtures/accounts/response_2.json
 - spec/fixtures/amorail_test.yml
+- spec/fixtures/authorize.json
 - spec/fixtures/contacts/create.json
 - spec/fixtures/contacts/find_many.json
 - spec/fixtures/contacts/find_one.json
@@ -244,6 +267,8 @@ files:
 - spec/note_spec.rb
 - spec/property_spec.rb
 - spec/spec_helper.rb
+- spec/store_adapters/memory_store_adapter_spec.rb
+- spec/store_adapters/redis_store_adapter_spec.rb
 - spec/support/elementable_example.rb
 - spec/support/entity_class_example.rb
 - spec/support/leadable_example.rb
@@ -255,7 +280,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -263,18 +288,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby API client for AmoCRM
 test_files:
+- spec/access_token_spec.rb
 - spec/client_spec.rb
 - spec/company_spec.rb
 - spec/contact_link_spec.rb
@@ -283,6 +309,7 @@ test_files:
 - spec/fixtures/accounts/response_1.json
 - spec/fixtures/accounts/response_2.json
 - spec/fixtures/amorail_test.yml
+- spec/fixtures/authorize.json
 - spec/fixtures/contacts/create.json
 - spec/fixtures/contacts/find_many.json
 - spec/fixtures/contacts/find_one.json
@@ -303,6 +330,8 @@ test_files:
 - spec/note_spec.rb
 - spec/property_spec.rb
 - spec/spec_helper.rb
+- spec/store_adapters/memory_store_adapter_spec.rb
+- spec/store_adapters/redis_store_adapter_spec.rb
 - spec/support/elementable_example.rb
 - spec/support/entity_class_example.rb
 - spec/support/leadable_example.rb

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-
-before_install: gem install bundler -v 1.13.6
-
-notifications:
-  email: false