http_store 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efe74a757031f1123ecc87e61f81e2743ee95a8edb288a5feab2097a621c59cb
-  data.tar.gz: ee93a150b6b6059663cfc73ce91d013777c0e876c66ccdc6204f32ca5ca18189
+  metadata.gz: 2c630613b04c77a91abcfd9de63daa0f77f8c0942775a45a07c108f91b2a2e33
+  data.tar.gz: dadd6adda88db7852f73a467276d4ec61ce00e0889d7d865db21cc5d8f365ec2
 SHA512:
-  metadata.gz: a5d5c446224bfeb89f9c4336b53f572f0b2db3bbf83d3c366c70898f9bf6b9cb82c1270fbb662cad65cabaf13855b84dfc6701775912d548115453af07aa5989
-  data.tar.gz: '09e9c146add47d8cb6482cc0e98d59ba289d1783ba227c02402339fb5b25372d839e77a76bcec5c71a4ba7ed9d3b56ba4f6bcb4546c8be2045bfc8edb979efb7'
+  metadata.gz: 72c9b03b19e5521d94ccde93bf3572fa59de2207783ec52ab9300a0a7761d4febbf3bde07f018f8835adab3a37208ff3938908f9fe8326c4f93b2c280dd967fd
+  data.tar.gz: 4ef08840bf1668823f0305d5f5dda5238af5d9693a8cf375f9908680562e0ec2c7b893d4b7cb3f8342da14cefd97cac3b3ebbd13188857bd9329447843060c87

data/Gemfile.lock

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

data/README.md

@@ -18,37 +18,72 @@ Or install it yourself as:
 
     $ gem install http_store
 
-## Usage
+## Default Usage
 
 first, you need create migration whit this command.
 
+```bash
+rake http_store_engine:install:migrations # create table(default)
+rails generator http_store:initializer    # create global settings
 ```
-rake http_store_engine:install:migrations
-```
 
-and you can extend the HttpStore::RestRequest to create your rest-client request.
 
-```ruby 
-class YourRequest < HttpStore::RestRequest
-  def build_request
-    @query_params_hash = {   
-      ..
+### HttpStore::Client
+you can extend the `HttpStore::Client` to create your rest-client request.
+
+```ruby
+class BaseClient < HttpStore::Client  
+  # support `http_method url data_type headers query_params data` keys
+  # url not include the query, use query_params to set query
+  def set_request
+    {
+      data_type:   'json', # support json/form default form 
+      data:        {},     # http body data
+      headers:     {},     # request headers
+      http_method: 'post', # support get/post default post
+      url:         'url'
     }
-    
-    self.http_method = 'POST'
-    self.url         = 'https://www.example.com'
+  end              
+                                 
+  # generate you request digest meta data,
+  # default keys is `http_method url data_type data other_params requestable_id requestable_type`  
+  def request_digest_hash  
+    super.merge(test: 'your value')  
   end
-    
-  def response_status_check
-    status_code == 200 && response_hash.access_token.present?
+                          
+  # request checker, default is true, if return falsely the request not send 
+  def request_valid?
+    true 
+  end  
+
+  # response valid, check response, if return true, next same request will use cache 
+  def response_valid?
+    status_code == 200 
   end
-    
-  def rsp_success_data
-    response_hash.access_token
+           
+  def build_response_data
+    if response_valid
+      response.data
+    else
+      response.error
+    end
   end
 end
 ```
 
+### HttpStore::HttpLog
+
+Default use activerecord, you can to rewrite it by setting
+
+### Configuration
+
+- store_enable: default is true
+- store_class: default is `HttpStore::HttpLog`
+
+### File storable
+
+When request/response having a file(size limit 30_000), it will use `storable_hash` to format to a hash, `{digest: '', origin: data[0..1000]'}` 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/db/migrate/1_create_http_logs.rb

@@ -13,6 +13,7 @@ class CreateHttpLogs < ActiveRecord::Migration[5.2]
       t.text :other_params, comment: '其他自定义参数, 用于构建 query_params/data_type'
       t.string :request_digest, comment: '请求唯一 id'
       t.boolean :request_valid, comment: '请求是否符合规范, 若为 false, 不会发起请求'
+      t.boolean :force, comment: '忽略缓存, 强制请求'
 
       # response
       t.integer :status_code, comment: 'response http code'

data/lib/http_store.rb

@@ -8,12 +8,12 @@ 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]
+  REQUEST_KEYS  = %w[http_method url data_type headers query_params data other_params force 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]
+  DIGEST_KEYS = %w[http_method url data_type data other_params requestable_id requestable_type]
   ALL_KEYS    = REQUEST_KEYS + RESPONSE_KEYS + META_KEYS + TMP_KEYS
   STORE_KEYS  = REQUEST_KEYS + RESPONSE_KEYS + META_KEYS
 

data/lib/http_store/client.rb

@@ -16,8 +16,8 @@ module HttpStore
 
       return unless request_valid?
 
-      # exist request, so return
-      return if !@meta.other_params.force && storeable_record.present?
+      # exist request or not force, return
+      return if !force && storeable_record.present?
 
       execute # send request
       raise HttpStore::RequestError, 'response_obj is nil' if response_obj.nil?

data/lib/http_store/helpers/requestable.rb

@@ -39,14 +39,19 @@ module HttpStore
         @meta.requestable_id   = requestable.try(:id)
         @meta.requestable_type = requestable.try(:class).try(:to_s)
         @meta.client_type      = self.class.to_s
+        @meta.force            = @meta.other_params.delete(:force) || false
         @meta.request_digest   = gen_request_digest
 
         @meta.request_valid = request_valid?
       end
 
+      # http_method url data_type data other_params requestable_id requestable_type
+      def request_digest_hash
+        @meta.slice(*HttpStore::DIGEST_KEYS)
+      end
+
       def gen_request_digest
-        request_str = storable_hash(@meta.slice(*HttpStore::DIGEST_KEYS)).to_json
-        Digest::SHA1.hexdigest(request_str)
+        Digest::SHA1.hexdigest(storable_hash(request_digest_hash).to_json)
       end
     end
   end

data/lib/http_store/helpers/responseable.rb

@@ -2,7 +2,7 @@ module HttpStore
   module Helpers
     module Responseable
       # check response message is right, if is right
-      def response_status_check
+      def response_valid?
         status_code == 200
       end
 
@@ -15,7 +15,7 @@ module HttpStore
         @meta.response         = json_safe_parse(response_obj.body)
         @meta.response_headers = response_obj.headers
 
-        @meta.response_valid = !!response_status_check
+        @meta.response_valid = response_valid?
         @meta.response_data  = build_response_data
         raise HttpStore::RequestError, '三方请求异常, 请与管理员联系' if response_data.blank?
       end

data/lib/http_store/version.rb

@@ -1,3 +1,3 @@
 module HttpStore
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_store
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client