http_store 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56d5372d4f8a5d499a4556320d98ff1af22a2bb9ed04b8ff76033dc1e5fb94d0
-  data.tar.gz: 48fe733db93cf5ac6fcd0f671e34e576b2ab936f10fd3e8f266cce1843d42f1c
+  metadata.gz: d19ed690d1cf9d1fb09ea54be7077ba76d99de22adef71981d8ec223ef9233f2
+  data.tar.gz: 67e08a8941b383daf5ddf8c682848b1436d74a1aa18029b49137f6c17265cf90
 SHA512:
-  metadata.gz: 0c7bfebf305491f6ae57bcb0a938605579eec3490611737533a090172d15f7f2f4813dec758b68d64373bd756dd0055db23be15f04af0d98f996575474a031a7
-  data.tar.gz: 151159953eb67f376fb0a6181eadadeb67d447894a9e482b275c50beddf8da6d1cac42d48ef17bddf61de4c60731f01acb33a8c6a56d508764b3ef96a0b81bc6
+  metadata.gz: e5ea3799b181497e6b2a323743a440d598992837ccc421982c4e6177615ed13a0e30ad01b535348d9dbf5f0afd8207ddeaec5f1d9c1f42ce52d7797f9e0ec431
+  data.tar.gz: 248bacb945b9f30c1c878f925e9c1607786c94fbea26b6c37841f88e984c9349dd592c051c8067c0bd74d5542b90fe28e0eb7acaeca5de798547d03d3c25dca3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    http_store (0.2.1)
+    http_store (0.3.0)
       activerecord (>= 5.0, < 6.1)
       hashie (~> 3.0)
       rails (>= 5, < 7)

data/db/migrate/1_create_http_logs.rb

@@ -24,7 +24,7 @@ class CreateHttpLogs < ActiveRecord::Migration[5.2]
       t.text :response_data, comment: '格式化后的 response'
 
       # relation
-      t.string :type, comment: '请求类型'
+      t.string :client_type, comment: '请求类型'
       t.string :requestable_id, comment: '外键 ID'
       t.string :requestable_type, comment: '外键 类型'
 

data/lib/generators/http_store/initializer_generator.rb

@@ -0,0 +1,12 @@
+module HttpStore
+  class InitializerGenerator < Rails::Generators::Base
+    def create_initializer_file
+      create_file "config/initializers/http_store.rb", <<FILE
+# HttpStore Config
+HttpStore.configure do
+end
+FILE
+
+    end
+  end
+end

data/lib/http_store/client.rb

@@ -1,9 +1,5 @@
 module HttpStore
   class Client
-    META_KEYS = %w[http_method url data_type headers query_params data other_params request_valid
-                   status_code response response_headers response_valid response_data
-                   request_digest type requestable requestable_id requestable_type response_obj]
-
     attr_accessor :meta
 
     include HttpStore::Helpers::Requestable
@@ -11,18 +7,19 @@ module HttpStore
     include HttpStore::Helpers::Storable
 
     def self.execute(requestable, other_params = {})
-      new(requestable:  requestable,
-          type:         to_s,
-          other_params: other_params)
+      new(requestable: requestable, other_params: other_params)
     end
 
     def initialize(args)
-      @meta                = Hashie::Mash.new(args)
-      @meta.request_digest = gen_request_digest(@meta.to_json)
-
+      @meta = Hashie::Mash.new(args)
       build_request
 
-      execute if request_valid # send request
+      return unless request_valid?
+
+      # exist request, so return
+      return if !@meta.other_params.force && storeable_record.present?
+
+      execute # send request
       raise HttpStore::RequestError, 'response_obj is nil' if response_obj.nil?
 
       build_response
@@ -30,11 +27,7 @@ module HttpStore
       store_request
     end
 
-    def gen_request_digest(str)
-      Digest::SHA1.hexdigest(str)
-    end
-
-    META_KEYS.each do |meta_key|
+    HttpStore::ALL_KEYS.each do |meta_key|
       define_method meta_key do
         @meta.send(meta_key)
       end

data/lib/http_store/configuration.rb

@@ -0,0 +1,13 @@
+module HttpStore
+  class Configuration
+    attr_writer :store_enable, :store_class
+
+    def store_enable
+      @store_enable || true
+    end
+
+    def store_class
+      @store_class || HttpStore::HttpLog
+    end
+  end
+end

data/lib/http_store/helpers/requestable.rb

@@ -36,8 +36,18 @@ module HttpStore
         @meta.query_params ||= {}
         @meta.data         ||= {}
 
+        @meta.requestable_id   = requestable.try(:id)
+        @meta.requestable_type = requestable.try(:class).try(:to_s)
+        @meta.client_type      = self.class.to_s
+        @meta.request_digest   = gen_request_digest
+
         @meta.request_valid = request_valid?
       end
+
+      def gen_request_digest
+        request_str = storable_hash(@meta.slice(*HttpStore::DIGEST_KEYS)).to_json
+        Digest::SHA1.hexdigest(request_str)
+      end
     end
   end
 end

data/lib/http_store/helpers/responseable.rb

@@ -6,14 +6,6 @@ module HttpStore
         status_code == 200
       end
 
-      def response_error_handle
-        'error'
-      end
-
-      def response_success_handle
-        'success'
-      end
-
       def json_response?
         response_headers_hash['content_type'].to_s =~ /json/
       end
@@ -24,7 +16,12 @@ module HttpStore
         @meta.response_headers = response_obj.headers
 
         @meta.response_valid = !!response_status_check
-        @meta.response_data  = response_valid ? response_success_handle : response_error_handle
+        @meta.response_data  = build_response_data
+        raise HttpStore::RequestError, '三方请求异常, 请与管理员联系' if response_data.blank?
+      end
+
+      def build_response_data
+        response_valid ? 'success' : 'error'
       end
     end
   end

data/lib/http_store/helpers/storable.rb

@@ -2,21 +2,28 @@ module HttpStore
   module Helpers
     module Storable
       STRING_LIMIT_SIZE = 30_000
-      STORE_KEYS        = HttpStore::Client::META_KEYS - %w[response_obj requestable]
+
+      def storeable_record
+        return unless HttpStore.config.store_enable
+
+        @storeable_model ||= HttpStore.config.store_class.find_by(request_digest: request_digest, response_valid: true)
+      end
 
       # you can rewrite this callback, to store the request
       def store_request
-        return if other_params.store_class == false
+        return unless HttpStore.config.store_enable
 
-        (other_params.store_class || HttpStore::HttpLog).new(storable_meta).save
+        storeable_class.new(storable_meta).save
       end
 
+      private
+
       def storable_meta
         @storable_meta ||= gen_storable_meta
       end
 
       def gen_storable_meta
-        @meta.slice(*STORE_KEYS).map do |k, v|
+        @meta.slice(*HttpStore::STORE_KEYS).map do |k, v|
           [k, v.is_a?(Hash) ? storable_hash(v).to_json[0..STRING_LIMIT_SIZE] : v]
         end.to_h
       end
@@ -28,6 +35,8 @@ module HttpStore
                 storable_hash(v)
               when String
                 storable_string(v)
+              when Class
+                v.to_s
               else
                 v
               end
@@ -36,7 +45,7 @@ module HttpStore
       end
 
       def storable_string(str)
-        { digest: Digest::SHA1.hexdigest(str), origin: str[0..1000] } if str.length > STRING_LIMIT_SIZE
+        str.length > STRING_LIMIT_SIZE ? { digest: Digest::SHA1.hexdigest(str), origin: str[0..1000] } : str
       end
     end
   end

data/lib/http_store/version.rb

@@ -1,3 +1,3 @@
 module HttpStore
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/http_store.rb

@@ -1,13 +1,24 @@
 require 'active_record'
 require 'rails/engine'
 require 'active_support/core_ext/module'
-
 require 'hashie'
 require 'rest-client'
+require 'http_store/engine'
 
 module HttpStore
   extend ActiveSupport::Autoload
 
+  REQUEST_KEYS  = %w[http_method url data_type headers query_params data other_params request_valid]
+  RESPONSE_KEYS = %w[status_code response response_headers response_data response_valid]
+  META_KEYS     = %w[request_digest client_type requestable_id requestable_type]
+  TMP_KEYS      = %w[requestable response_obj]
+
+  DIGEST_KEYS = REQUEST_KEYS + %w[requestable_id requestable_type]
+  ALL_KEYS    = REQUEST_KEYS + RESPONSE_KEYS + META_KEYS + TMP_KEYS
+  STORE_KEYS  = REQUEST_KEYS + RESPONSE_KEYS + META_KEYS
+
+  class RequestError < StandardError; end
+
   module Helpers
     extend ActiveSupport::Autoload
 
@@ -20,6 +31,15 @@ module HttpStore
   autoload :VERSION
   autoload :HttpLog
   autoload :Client
+  autoload :Configuration
 
-  class RequestError < StandardError; end
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure(&block)
+      yield(config)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_store
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -153,8 +153,10 @@ files:
 - bin/setup
 - db/migrate/1_create_http_logs.rb
 - http_store.gemspec
+- lib/generators/http_store/initializer_generator.rb
 - lib/http_store.rb
 - lib/http_store/client.rb
+- lib/http_store/configuration.rb
 - lib/http_store/engine.rb
 - lib/http_store/helpers/requestable.rb
 - lib/http_store/helpers/responseable.rb