admqr_knife 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06b0ffb1b6364cd47bf389fc0d89ae5176718656ae0eed5f24605466ef94ff81
+  data.tar.gz: ffecc85d0926b3cf57816b4e27614210dd855929dffae768151d901bb26e3e9f
+SHA512:
+  metadata.gz: 9b768ac52b9cd58afa860ebb84e0f49ca17c5fce6b763dacd24f5fa7f66b18d1c05742961aaccc686f939fc6a4a1c86b5ecadbf1d378c7d7fe8e604d9ffca283
+  data.tar.gz: 77188b9318160d324aeca149be0872e5f7914bd850f31cb067f19f85d8e92de0666827088fc8e635cfb99c571f0312229a96d212875929d0d15c9980eb87e2a5

data/.gitignore

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

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.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at atpking@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    admqr_knife (0.1.0)
+      api_tools
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    api_tools (0.1.0)
+      multi_json
+      rest-client (~> 2.0)
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_json (1.14.1)
+    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.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  admqr_knife!
+  bundler (~> 2.0)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 atpking
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# AdmqrKnife
+
+通过第三方转发统计信息给毛驴短链, 这样就可以做到不用用户访问访问, 将用户的信息直接转发即可
+
+特别适合与做漏斗 
+
+比如曝光页面用毛驴做了统计 
+
+就可以在注册的时候再次发起一次统计, 即可得出曝光转化比
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'admqr_knife'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install admqr_knife
+
+## Usage
+
+### 命令行方式
+
+`admqr_visit record 标签名称 -t API_TOKEN`
+
+更多参数可以使用 `admqr_visit help record` 进行查看 
+
+
+### gem 集成
+
+1. 在 rails 里 initializers 中配置 
+
+```ruby
+AdmqrKnife.init(API_TOKEN)
+```
+
+2. 在需要记录的地方使用如下语法记录
+
+```ruby
+AdmqrKnife.visit unique_code: "唯一标记",
+                       ua: ua, # UA , 可不传
+                       referer: referer, # 来自于 , 可不传
+                       tag: tag, # 分组名 , 可不传
+                       new_to_visit: new_to_visit,  # 是否是今日首次访问 , 可不传, 默认是
+                       remote_ip: remote_ip # "用户IP"
+```
+
+### 直接发请求或集成第三方
+
+这种使用方式不需要安装这个gem
+
+```
+curl -X POST \
+  https://www.admqr.com/apic/v1 \
+  -H 'Content-Type: application/json' \
+  -d '{
+	"api_token": "你的API_TOKEN",
+	"unique_code": "自己取的唯一标志",
+    "tag": "分组名, 可以不传",
+	"client_ua": "用户UA, 可以不传",
+	"referer": "来自于, 可以不传",
+    "new_to_visit": 是否是首次访问 true or false, 可以不传, 默认为true
+    "remote_ip": '用户的ip, 可以不传'
+}'
+```
+
+## 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]/admqr_knife. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AdmqrKnife project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/admqr_knife/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/admqr_knife.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "admqr_knife/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "admqr_knife"
+  spec.version       = AdmqrKnife::VERSION
+  spec.authors       = ["atpking"]
+  spec.email         = ["atpking@gmail.com"]
+
+  spec.summary       = 'send vsist record to admqr service'
+  spec.description   = 'send vsist record to admqr service'
+  spec.homepage      = "https://www.admqr.com"
+  spec.license       = "MIT"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency 'api_tools'
+  spec.add_dependency 'thor'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "admqr_knife"
+
+# 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/exe/admqr_visit

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'thor'
+# require 'byebug'
+require_relative '../lib/admqr_knife'
+
+
+class AdmqrVisitCLI < Thor
+  desc 'record', 'record a visit data'
+  option :api_token, :aliases => "-t", required: true, desc: "API TOKEN"
+  option :ua, desc: "visitor's user agent"
+  option :referer, desc: 'visitor from '
+  option :tag, desc: 'project name'
+  option :new_to_visit, type: :boolean, desc: 'is a new visit', default: true
+  def record(unique_code)
+    AdmqrKnife.init(options[:api_token])
+    AdmqrKnife.visit(unique_code: unique_code,
+                     ua: options[:ua],
+                     referer: options[:referer],
+                     tag: options[:tag],
+                     new_to_visit: options[:new_to_visit],
+                     remote_ip: options[:remote_ip])
+    AdmqrKnife.logger.debug("ok!")
+  end
+
+  desc 'help', 'Describe available commands or one specific command (aliases: `h`).'
+    map Thor::HELP_MAPPINGS => :help
+    def help(command = nil, subcommand = false)
+      super
+    end
+
+
+end
+
+AdmqrVisitCLI.start(ARGV)

data/lib/admqr_knife.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'admqr_knife/version'
+require 'api_tools'
+# require 'byebug'
+require_relative './admqr_knife/cube_service'
+
+module AdmqrKnife
+  class Error < StandardError; end
+  # Your code goes here...
+  class << self
+    attr_accessor :knife_api_token, :knife_base_uri, :logger
+
+    def init(api_token = nil, options = {})
+      @knife_api_token = api_token || ENV['ADMQR_KNIFE_API_TOKEN']
+      @knife_base_uri = ENV['KNIFE_BASE_URI'] || 'https://www.admqr.com/apic/v1/'
+      @logger = options[:logger] || select_logger
+    end
+
+    def api_token
+      @knife_api_token
+    end
+
+    def visit(unique_code:, **options)
+      raise 'unique_code 不能为空' if unique_code.to_s == ''
+
+      ua = options[:ua]
+      referer = options[:referer]
+      tag = options[:tag]
+      new_to_visit = options[:new_to_visit]
+      remote_ip = options[:remote_ip]
+      CubeService.post('/api/knifes/statis',
+                       { unique_code: unique_code,
+                         client_ua: ua,
+                         referer: referer,
+                         tag: tag,
+                         new_to_visit: new_to_visit,
+                         remote_ip: remote_ip }.reject! { |_k, v| v.nil? })
+    rescue StandardError => e
+      logger.error e.message
+    end
+
+    private
+
+    def select_logger
+      return Rails.logger if defined? Rails
+
+      Logger.new(STDOUT)
+    end
+  end
+end

data/lib/admqr_knife/cube_service.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AdmqrKnife
+  class CubeService < DefaultRest
+    class << self
+      def basic_url
+        AdmqrKnife.knife_base_uri
+      end
+
+      def base_params
+        {
+          api_token: AdmqrKnife.knife_api_token,
+          gem_version: AdmqrKnife::VERSION 
+        }
+      end
+    end
+
+  end
+end

data/lib/admqr_knife/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: admqr_knife
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- atpking
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-02 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: api_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: send vsist record to admqr service
+email:
+- atpking@gmail.com
+executables:
+- admqr_visit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- admqr_knife.gemspec
+- bin/console
+- bin/setup
+- exe/admqr_visit
+- lib/admqr_knife.rb
+- lib/admqr_knife/cube_service.rb
+- lib/admqr_knife/version.rb
+homepage: https://www.admqr.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.admqr.com
+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.3
+signing_key: 
+specification_version: 4
+summary: send vsist record to admqr service
+test_files: []