amorail 0.5.0 → 0.7.1

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/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/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Amorail version
 module Amorail
-  VERSION = "0.5.0".freeze
+  VERSION = '0.7.1'
 end

data/lib/amorail.rb

@@ -1,37 +1,43 @@
+# frozen_string_literal: true
+
 require 'amorail/version'
 require 'amorail/config'
 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
@@ -39,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/tasks/amorail.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :amorail do
   desc 'Check Amorail configuration'
   task :check do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Amorail::Client do
@@ -7,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
 
@@ -24,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
@@ -81,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
@@ -94,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
@@ -105,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/company_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Amorail::Company do

data/spec/contact_link_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Amorail::ContactLink do

data/spec/contact_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Amorail::Contact do
@@ -166,10 +168,12 @@ describe Amorail::Contact do
     it "update params" do
       contact.save!
       contact.name = "foo"
+      contact.phone = "123456789"
 
       contact_update_stub(Amorail.config.api_endpoint)
       expect(contact.save!).to be_truthy
       expect(contact.name).to eq "foo"
+      expect(contact.phone).to eq "123456789"
     end
 
     it "raise error if id is blank?" do

data/spec/entity_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe MyEntity do

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/fixtures/contacts/my_contact_find.json

@@ -27,6 +27,10 @@
               {
                 "value": "1111 111 111",
                 "enum": "3392086"
+              },
+              {
+                "value": "2222 222 222",
+                "enum": "3392086"
               }
             ]
           },

data/spec/helpers/webmock_helpers.rb

@@ -1,36 +1,73 @@
+# frozen_string_literal: true
+
 # rubocop: disable Metrics/ModuleLength
 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/lead_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Amorail::Lead do

data/spec/my_contact_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe MyContact do
@@ -12,7 +14,7 @@ describe MyContact do
   end
 
   describe "#params" do
-    let(:company) do
+    let(:contact) do
       described_class.new(
         name: 'Test inc',
         phone: '12345678',
@@ -21,7 +23,7 @@ describe MyContact do
       )
     end
 
-    subject { company.params }
+    subject { contact.params }
 
     specify { is_expected.to include(:last_modified) }
     specify { is_expected.to include(name: 'Test inc') }
@@ -41,6 +43,7 @@ describe MyContact do
       expect(obj.id).to eq 11
       expect(obj.company_name).to eq "Foo Inc."
       expect(obj.email).to eq "foo@tb.com"
+      expect(obj.phone).to eq ["1111 111 111", "2222 222 222"]
       expect(obj.teachbase_id).to eq 1123
       expect(obj.params[:id]).to eq 11
     end

data/spec/note_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Amorail::Note do

data/spec/property_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 require "webmock/rspec"
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))