http_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37267dbaf2e539e27cb577b0774c53c1cc78b0ab601dfeb939bce2c8a24b3183
+  data.tar.gz: 9bd3f0cb27141be490293d52a1dfed63d14e09d0d2fd8348b295047e1ebfe6b1
+SHA512:
+  metadata.gz: 22773739e8b21d29dccc55f3348b5e1199dfea8084a599a260d10ba33c2ba9db06016f9303e3f290cac680a5e31ddd2eafc52e34475f8ebdadf008df58fbe841
+  data.tar.gz: 4aa1805a664e2e4a3fea921b924eba2ba52bb9464f1cfe386d625ded5bf62961339f291a57c202baf8369be01e2ff0b846c151d111388cb0df98db42f7d8d3d5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in http_store.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    http_store (0.1.0)
+      activerecord (>= 5.0, < 6.1)
+      hashie (~> 3.0)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    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)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.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)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0904)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 11.0)
+  http_store!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,60 @@
+# HttpStore
+
+This is a http client, based on rest-client. It provide a activerecord table to save the request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_store
+
+## Usage
+
+first, you need create migration whit this command.
+
+```
+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 = {   
+      ..
+    }
+    
+    self.http_method = 'POST'
+    self.url         = 'https://www.example.com'
+  end
+    
+  def response_status_check
+    status_code == 200 && response_hash.access_token.present?
+  end
+    
+  def rsp_success_data
+    response_hash.access_token
+  end
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/http_store.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "http_store"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db/migrate/1_create_rest_requests.rb

@@ -0,0 +1,26 @@
+class CreateRestRequests < ActiveRecord::Migration[5.2]
+  def change
+    create_table :rest_requests do |t|
+      t.string :http_method, comment: '请求方法'
+      t.string :url, comment: '请求 URL'
+      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.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 来确定'
+      t.text :response_data, comment: '格式化后的 response'
+
+      t.string :type, comment: '请求类型'
+      t.string :requestable_id, comment: '外键 ID'
+      t.string :requestable_type, comment: '外键 类型'
+      t.boolean :is_valid, comment: '请求是否成功'
+
+      t.timestamps
+    end
+  end
+end

data/http_store.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "http_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "http_store"
+  spec.version = HttpStore::VERSION
+  spec.authors = ["black"]
+  spec.email   = ["black@paimingjia.com"]
+
+  spec.summary     = %q{store the http request, it based on rest-client}
+  spec.description = %q{This lib is based on rest-clint http client. It generate a table to store the http request info}
+  spec.homepage    = "https://github.com/308820773/http-store"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/308820773/http-store"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", '~> 2.0'
+  spec.add_dependency "hashie", '~> 3.0'
+  spec.add_dependency "activerecord", '>= 5.0', '< 6.1'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 11.0"
+end
+

data/lib/generators/initializer_generator.rb

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

data/lib/http_store/engine.rb

@@ -0,0 +1,4 @@
+module HttpStore
+  class Engine < Rails::Engine
+  end
+end

data/lib/http_store/requestable.rb

@@ -0,0 +1,38 @@
+module HttpStore
+  module Requestable
+    def build_request
+      # callback
+    end
+
+    def request_valid?
+      true
+    end
+
+    def json_request?
+      data_type.to_s.casecmp('json').zero?
+    end
+
+    def file_request?
+      @data_hash.to_json.size > GRAPE_API::HTTP_FILE_SIZE_LIMIT
+    end
+
+    def get?
+      http_method.to_s.casecmp('get').zero?
+    end
+
+    def post?
+      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?
+
+      self.headers      = @headers_hash.to_json
+      self.data         = @data_hash.to_json unless file_request?
+      self.query_params = @query_params_hash.to_json
+    end
+  end
+end

data/lib/http_store/responseable.rb

@@ -0,0 +1,38 @@
+module HttpStore
+  module Responseable
+    attr_accessor :response_obj
+
+    # 判断请求是否到达第三方接口, 并处理. 若为 true 不再重复调用
+    def response_status_check
+      status_code == 200
+    end
+
+    def json_response?
+      response_headers_hash['content_type'].to_s =~ /json/
+    end
+
+    def file_response?
+      response_headers_hash['content_type'].to_s =~ /(stream|file)/
+    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!
+    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 result
+      response_data_hash.data.presence || response_data_hash.error.presence
+    end
+  end
+end

data/lib/http_store/rest_request.rb

@@ -0,0 +1,90 @@
+# == 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

data/lib/http_store/version.rb

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

data/lib/http_store.rb

@@ -0,0 +1,15 @@
+require "http_store/version"
+require 'byebug'
+require 'active_record'
+require 'rails/engine'
+require 'http_store/engine'
+require 'active_support/core_ext/module'
+
+module HttpStore
+  class Error < StandardError; end
+  extend ActiveSupport::Autoload
+
+  autoload :Requestable
+  autoload :Responseable
+  autoload :RestRequest
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: http_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- black
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: This lib is based on rest-clint http client. It generate a table to store
+  the http request info
+email:
+- black@paimingjia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/migrate/1_create_rest_requests.rb
+- http_store.gemspec
+- lib/generators/initializer_generator.rb
+- lib/http_store.rb
+- lib/http_store/engine.rb
+- lib/http_store/requestable.rb
+- lib/http_store/responseable.rb
+- lib/http_store/rest_request.rb
+- lib/http_store/version.rb
+homepage: https://github.com/308820773/http-store
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/308820773/http-store
+  source_code_uri: https://github.com/308820773/http-store
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: store the http request, it based on rest-client
+test_files: []