http_store 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37267dbaf2e539e27cb577b0774c53c1cc78b0ab601dfeb939bce2c8a24b3183
-  data.tar.gz: 9bd3f0cb27141be490293d52a1dfed63d14e09d0d2fd8348b295047e1ebfe6b1
+  metadata.gz: e46d9d716290cd38b9293d0d3ae10a6d387cb2ce02712e180fdd060a9da2bb2b
+  data.tar.gz: a313bfb9874387e2f3a3a738d05c273b883824cccdd826b9eb85fba2008dfc54
 SHA512:
-  metadata.gz: 22773739e8b21d29dccc55f3348b5e1199dfea8084a599a260d10ba33c2ba9db06016f9303e3f290cac680a5e31ddd2eafc52e34475f8ebdadf008df58fbe841
-  data.tar.gz: 4aa1805a664e2e4a3fea921b924eba2ba52bb9464f1cfe386d625ded5bf62961339f291a57c202baf8369be01e2ff0b846c151d111388cb0df98db42f7d8d3d5
+  metadata.gz: 752515be72b99a4ea27e493c143afdedb69308bb37d92ffca0ea1de584a075150e63f5dc1a3d0c4da018a76947b32fd35d1ece54cd825988468f05b799691758
+  data.tar.gz: 1c25fd60ad38d88054189b5faa7e7d2b3ffba5c9cb681e4800919fa9c3ddd57ac7f39332993f20f4489f29fc5266b459e3ec75dad75c2de6f4ec7e807cece368

data/.gitignore

@@ -9,3 +9,11 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
+
+# Ignore RubyMine files
+.idea
+
+# Ignore bundler config.
+.bundle
+/vendor/bundle

data/Gemfile.lock

@@ -1,42 +1,119 @@
 PATH
   remote: .
   specs:
-    http_store (0.1.0)
+    http_store (0.2.0)
       activerecord (>= 5.0, < 6.1)
       hashie (~> 3.0)
+      rails (>= 5, < 7)
       rest-client (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
     activemodel (5.2.3)
       activesupport (= 5.2.3)
     activerecord (5.2.3)
       activemodel (= 5.2.3)
       activesupport (= 5.2.3)
       arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
     activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
+    builder (3.2.3)
     byebug (11.0.1)
     concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
     hashie (3.6.0)
     http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
     mime-types (3.3)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0904)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
     netrc (0.11.0)
+    nio4r (2.5.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rake (10.5.0)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -56,12 +133,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.6)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby

data/db/migrate/{1_create_rest_requests.rb → 1_create_http_logs.rb}

@@ -1,24 +1,32 @@
-class CreateRestRequests < ActiveRecord::Migration[5.2]
+class CreateHttpLogs < ActiveRecord::Migration[5.2]
   def change
-    create_table :rest_requests do |t|
+    create_table :http_logs do |t|
+      # request
       t.string :http_method, comment: '请求方法'
       t.string :url, comment: '请求 URL'
+      t.string :data_type, comment: 'data 参数类型 (form/json)'
       t.text :headers, comment: '请求 header'
       t.text :query_params, comment: 'url 参数'
-      t.string :data_type, comment: 'data 参数类型 (form/json)'
-      t.text   :data, comment: '参数'
-      t.text :request_data, comment: '可能和 query params 重复'
+      t.text :data, comment: 'body, get/delete 为空'
 
+      # request builder
+      t.text :other_params, comment: '其他自定义参数, 用于构建 query_params/data_type'
+      t.string :request_digest, comment: '请求唯一 id'
+      t.boolean :request_valid, comment: '请求是否符合规范, 若为 false, 不会发起请求'
+
+      # response
       t.integer :status_code, comment: 'response http code'
       t.text :response, comment: 'response body'
       t.text :response_headers, comment: 'response header'
-      t.boolean :response_status, comment: '请求结果 true/false, 这个要根据业务逻辑来设定. 不能靠 status_code 来确定'
+
+      # response checker
+      t.boolean :response_valid, comment: '请求结果 true/false, 这个要根据业务逻辑来设定. 不能靠 status_code 来确定'
       t.text :response_data, comment: '格式化后的 response'
 
+      # relation
       t.string :type, comment: '请求类型'
       t.string :requestable_id, comment: '外键 ID'
       t.string :requestable_type, comment: '外键 类型'
-      t.boolean :is_valid, comment: '请求是否成功'
 
       t.timestamps
     end

data/http_store.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rest-client", '~> 2.0'
   spec.add_dependency "hashie", '~> 3.0'
   spec.add_dependency "activerecord", '>= 5.0', '< 6.1'
+  spec.add_dependency "rails", ">= 5", "< 7"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/http_store/client.rb

@@ -0,0 +1,79 @@
+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::Requestable
+    include HttpStore::Responseable
+
+    def self.execute(requestable, other_params = {})
+      new(requestable:  requestable,
+          type:         to_s,
+          other_params: other_params)
+    end
+
+    def initialize(args)
+      @meta                = Hashie::Mash.new(args)
+      @meta.request_digest = gen_request_digest(@meta.to_json)
+
+      build_request
+
+      execute if request_valid # send request
+      raise HttpStore::RequestError, 'response_obj is nil' if response_obj.nil?
+
+      build_response
+    ensure
+      store_request
+    end
+
+    def gen_request_digest(str)
+      Digest::SHA1.hexdigest(str)
+    end
+
+    META_KEYS.each do |meta_key|
+      define_method meta_key do
+        @meta.send(meta_key)
+      end
+    end
+
+    private
+
+    def build_request
+      add_meta(set_request)
+      format_request
+    end
+
+    def add_meta(hash)
+      @meta.merge! Hashie::Mash.new(hash).slice(*META_KEYS)
+    end
+
+    def execute
+      @meta.response_obj = get? ? http_get_execute : http_post_execute
+    end
+
+    def http_get_execute
+      RestClient.get(uri, headers)
+    rescue RestClient::ExceptionWithResponse => e
+      # :nocov:
+      e.response
+      # :nocov:
+    end
+
+    def http_post_execute
+      real_data = json_request? ? data.to_json : data.to_hash
+      RestClient.post(uri, real_data, headers.symbolize_keys)
+    rescue RestClient::ExceptionWithResponse => e
+      # :nocov:
+      e.response
+      # :nocov:
+    end
+
+    def json_safe_parse(str)
+      JSON.parse(str) rescue str
+    end
+  end
+end
+

data/lib/http_store/http_log.rb

@@ -0,0 +1,5 @@
+module HttpStore
+  class HttpLog < ActiveRecord::Base
+    belongs_to :requestable, polymorphic: true, optional: true
+  end
+end

data/lib/http_store/requestable.rb

@@ -1,9 +1,11 @@
 module HttpStore
   module Requestable
-    def build_request
-      # callback
+    # will return one hash to set the request meta
+    def set_request
+      {}
     end
 
+    # you need rewrite this checker, when return false the request don't send
     def request_valid?
       true
     end
@@ -12,8 +14,8 @@ module HttpStore
       data_type.to_s.casecmp('json').zero?
     end
 
-    def file_request?
-      @data_hash.to_json.size > GRAPE_API::HTTP_FILE_SIZE_LIMIT
+    def uri
+      "#{url}?#{query_params.to_query}"
     end
 
     def get?
@@ -24,15 +26,16 @@ module HttpStore
       http_method.to_s.casecmp('post').zero?
     end
 
-    def default_request
-      @headers_hash                ||= { charset: 'UTF-8' } # accept: :json
-      @query_params_hash           ||= {}
-      @data_hash                   ||= {}
-      @headers_hash[:content_type] = :json if json_request?
+    def format_request
+      @meta.http_method = get? ? 'GET' : 'POST' # only support get/post
 
-      self.headers      = @headers_hash.to_json
-      self.data         = @data_hash.to_json unless file_request?
-      self.query_params = @query_params_hash.to_json
+      @meta.headers                ||= { charset: 'UTF-8' }
+      @meta.headers[:content_type] = :json if json_request?
+
+      @meta.query_params ||= {}
+      @meta.data         ||= {}
+
+      @meta.request_valid = request_valid?
     end
   end
 end

data/lib/http_store/responseable.rb

@@ -1,38 +1,29 @@
 module HttpStore
   module Responseable
-    attr_accessor :response_obj
-
-    # 判断请求是否到达第三方接口, 并处理. 若为 true 不再重复调用
+    # check response message is right, if is right
     def response_status_check
       status_code == 200
     end
 
-    def json_response?
-      response_headers_hash['content_type'].to_s =~ /json/
+    def response_error_handle
+      'error'
     end
 
-    def file_response?
-      response_headers_hash['content_type'].to_s =~ /(stream|file)/
+    def response_success_handle
+      'success'
     end
 
-    def save_response
-      self.status_code      = response_obj.code
-      self.response         = response_obj.body if response_obj.body.size < GRAPE_API::HTTP_FILE_SIZE_LIMIT && !file_response?
-      self.response_headers = response_obj.headers.to_json
-      save!
+    def json_response?
+      response_headers_hash['content_type'].to_s =~ /json/
     end
 
-    def save_response_result
-      self.response_status = !!response_status_check
-      @response_data_hash  = response_status ? { data: rsp_success_data } : { error: rsp_error_msg }
-      raise RestRequestError, '三方请求异常, 请与管理员联系' if result.blank?
-
-      self.response_data = @response_data_hash.to_json
-      save!
-    end
+    def build_response
+      @meta.status_code      = response_obj.code
+      @meta.response         = json_safe_parse(response_obj.body)
+      @meta.response_headers = response_obj.headers
 
-    def result
-      response_data_hash.data.presence || response_data_hash.error.presence
+      @meta.response_valid = !!response_status_check
+      @meta.response_data  = response_valid ? response_success_handle : response_error_handle
     end
   end
 end

data/lib/http_store/storable.rb

@@ -0,0 +1,41 @@
+module HttpStore
+  module Storable
+    STRING_LIMIT_SIZE = 30_000
+    STORE_KEYS        = HttpStore::Client::META_KEYS - %w[response_obj requestable]
+
+    # you can rewrite this callback, to store the request
+    def store_request
+      return if other_params.store_class != false
+
+      (other_params.store_class || HttpStore::HttpLog).new(storable_meta).save
+    end
+
+    def storable_meta
+      @storable_meta ||= gen_storable_meta
+    end
+
+    def gen_storable_meta
+      @meta.slice(*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
+
+    def storable_hash(hash)
+      hash.map do |k, v|
+        [k, case value
+            when Hash
+              storable_hash(v)
+            when String
+              storable_string(v)
+            else
+              v
+            end
+        ]
+      end.to_h
+    end
+
+    def storable_string(str)
+      { digest: Digest::SHA1.hexdigest(str), origin: str[0..1000] } if str.length > STRING_LIMIT_SIZE
+    end
+  end
+end

data/lib/http_store/version.rb

@@ -1,3 +1,3 @@
 module HttpStore
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/http_store.rb

@@ -1,15 +1,21 @@
-require "http_store/version"
-require 'byebug'
 require 'active_record'
 require 'rails/engine'
-require 'http_store/engine'
 require 'active_support/core_ext/module'
 
+require 'hashie'
+require 'rest-client'
+
 module HttpStore
-  class Error < StandardError; end
   extend ActiveSupport::Autoload
 
+  autoload :Engine
+  autoload :VERSION
+
   autoload :Requestable
   autoload :Responseable
-  autoload :RestRequest
+  autoload :Storable
+  autoload :HttpLog
+  autoload :Client
+
+  class RequestError < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -58,6 +58,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,14 +151,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- db/migrate/1_create_rest_requests.rb
+- db/migrate/1_create_http_logs.rb
 - http_store.gemspec
-- lib/generators/initializer_generator.rb
 - lib/http_store.rb
+- lib/http_store/client.rb
 - lib/http_store/engine.rb
+- lib/http_store/http_log.rb
 - lib/http_store/requestable.rb
 - lib/http_store/responseable.rb
-- lib/http_store/rest_request.rb
+- lib/http_store/storable.rb
 - lib/http_store/version.rb
 homepage: https://github.com/308820773/http-store
 licenses: []

data/lib/generators/initializer_generator.rb

@@ -1,5 +0,0 @@
-class InitializerGenerator < Rails::Generators::Base
-  def create_initializer_file
-    create_file "config/initializers/initializer.rb", "# 这里是初始化文件的内容"
-  end
-end

data/lib/http_store/rest_request.rb

@@ -1,90 +0,0 @@
-# == Schema Information
-#
-# Table name: rest_requests
-#
-#  id               :integer          not null, primary key
-#  http_method      :string(255)
-#  url              :string(255)
-#  headers          :text(65535)
-#  query_params     :text(65535)
-#  data_type        :string(255)
-#  data             :text(65535)
-#  status_code      :integer
-#  response         :text(65535)
-#  response_headers :text(65535)
-#  response_status  :boolean
-#  response_data    :text(65535)
-#  type             :string(255)
-#  requestable_id   :string(255)
-#  requestable_type :string(255)
-#  created_at       :datetime         not null
-#  updated_at       :datetime         not null
-#  request_data     :text(65535)
-#  is_valid         :boolean
-#
-
-module HttpStore
-  class RestRequest < ActiveRecord::Base
-    include HttpStore::Requestable
-    include HttpStore::Responseable
-
-    belongs_to :requestable, polymorphic: true, optional: false
-
-    def self.execute(attrs, &block)
-      req = new(attrs)
-      req.build_request
-      req.default_request
-      req.is_valid = req.request_valid?
-      req.save! # save request
-
-      req.execute(&block) if req.is_valid
-      req
-    end
-
-    def http_get_execute
-      RestClient.get("#{url}?#{query_params_hash.to_query}", headers_hash)
-    rescue RestClient::ExceptionWithResponse => e
-      # :nocov:
-      e.response
-      # :nocov:
-    end
-
-    def http_post_execute
-      real_data = json_request? ? data_hash.to_json : data_hash.to_hash
-      RestClient.post("#{url}?#{query_params_hash.to_query}", real_data, headers_hash.to_hash.symbolize_keys)
-    rescue RestClient::ExceptionWithResponse => e
-      # :nocov:
-      e.response
-      # :nocov:
-    end
-
-    def execute
-      self.response_obj = get? ? http_get_execute : http_post_execute
-      raise RestRequestError, 'response_obj is nil' unless response_obj
-
-      save_response
-      save_response_result
-
-      yield self if block_given?
-
-      self
-    end
-
-    %i[query_params_hash data_hash headers_hash request_data_hash
-     response_hash response_data_hash response_headers_hash].each do |hash_key|
-      define_method hash_key do
-        iv_key = "@#{hash_key}".to_sym
-
-        result =
-          if instance_variable_get(iv_key).present?
-            instance_variable_get(iv_key)
-          else
-            json_field = hash_key.to_s.gsub(/_hash/, '').to_sym
-            instance_variable_set iv_key, (JSON.parse(send(json_field)) rescue {})
-          end
-
-        Hashie::Mash.new(result) rescue Hashie::Mash.new({})
-      end
-    end
-  end
-end