ocean-wechat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c84fb045f758d8641894311894135dc3525cdcfc3a17701018bb50debe758d49
+  data.tar.gz: 7efcc812a28f9c6d355f014c0ee30caf4a037df5dc9c1820578e0a38ca8baa56
+SHA512:
+  metadata.gz: 6d11c3ffa7e096aab6e83afe347f21ffc941a4f1495f5e433e5511a28df7f85559d79c7662cbe00698e06e6bc865400999669c346cf84a287026dc3af4fc29a4
+  data.tar.gz: b9497e673889bb38f87e318e9ad19a00166931ccf8fb6391c906e9933f1159359090ce9a3d36265847920a04cc10692383c89028c730ffa0f24d0e03b1d3bf3e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 mr.bestjane@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ocean-wechat.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# Ocean::Wechat
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ocean/wechat`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ocean-wechat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ocean-wechat
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/ocean-wechat. 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.
+
+## Code of Conduct
+
+Everyone interacting in the Ocean::Wechat project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ocean-wechat/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ocean/wechat"
+
+# 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/lib/ocean/wechat/version.rb

@@ -0,0 +1,5 @@
+module Ocean
+  module Wechat
+    VERSION = "0.1.0"
+  end
+end

data/lib/ocean/wechat.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+# Wechat service, View more at: https://mp.weixin.qq.com/wiki
+# example:
+#   Wechat.notify(event: 'crash', first: 'Your website is not accessible', time: Time.now, reason: 'Connect fail!', remark: 'remark', redirect_url: 'www.baidu.com')
+module Wechat
+  extend self
+
+  BASE_URL = 'https://api.weixin.qq.com/cgi-bin'
+  ACCESS_TOKEN_FILE = 'tmp/access_token.txt'
+  NOTIFY_RECIPIENT_FILE = 'config/wechat_notify.yml'
+  SUCCESS_CODE = 0
+  ACCESS_TOKEN_EXPIRED_CODE = 420_01
+  ACCESS_TOKEN_INVALID_CODE = 400_01
+  NOTIFY_DEFAULT_COLOR = '#173177'
+  MAX_RETRY_NUM = 5
+
+  def access_token
+    read_access_token || refresh_access_token
+  end
+
+  # Use wechat template to send message
+  def notify(**args)
+    notify_block = lambda do |open_id|
+      url = "#{BASE_URL}/message/template/send"
+      params = {
+        touser: open_id,
+        template_id: wechat_notify(args[:event], 'template'),
+        url: args[:redirect_url],
+        data: {}
+      }
+
+      args.each { |k, v| params[:data][k] = { value: v, color: NOTIFY_DEFAULT_COLOR } }
+
+      request(url, params, :post)
+    end
+
+    [].tap do |item|
+      wechat_notify(args[:event], 'users').each do |open_id|
+        item << {
+          open_id: open_id,
+          success: notify_block.call(open_id)[:errcode] == SUCCESS_CODE
+        }
+      end
+    end
+  end
+
+  # Get all notify template
+  def notify_templates
+    request("#{BASE_URL}/template/get_all_private_template")
+  end
+
+  # Get all followers
+  def users
+    request("#{BASE_URL}/user/get")
+  end
+
+  def create_user_tag(name)
+    params = {
+      tag: {
+        name: name
+      }
+    }
+
+    request("#{BASE_URL}/tags/create", params, :post)
+  end
+
+  # Get all user tag
+  def user_tags
+    request("#{BASE_URL}/tags/get")
+  end
+
+  def find_users_by_tag(name)
+    res = request(
+      "#{BASE_URL}/user/tag/get",
+      {
+        tagid: find_tag_id_by_name(name)
+      },
+      :post
+    )
+
+    res['count'] == 0 ? [] : res['data']['openid']
+  end
+
+  def find_tag_id_by_name(name)
+    user_tags[:tags].detect { |item| item['name'] == name }['id']
+  end
+
+  def add_tag_for_users(users, tag_id)
+    params = {
+      open_list: users,
+      tagid: tag_id
+    }
+
+    request("#{BASE_URL}/tags/members/batchtagging",  params, :post)
+  end
+
+private
+
+  def request(source_url, params = {}, method = :get, retry_num = 0)
+    url = compose_url(source_url)
+
+    log.debug "Send #{method} request #{params} to #{url}"
+
+    res = if method == :get
+            RestClient.get(url, params)
+          else
+            RestClient.post(url, params.to_json, content_type: :json, accept: :json)
+          end
+
+    res_body = read_content(res)
+    json = JSON.parse force_encoding(res_body)
+
+    json.symbolize_keys!
+
+    if json[:errcode] == ACCESS_TOKEN_EXPIRED_CODE || json[:errcode] == ACCESS_TOKEN_INVALID_CODE
+      # Try again five times at most
+      return if retry_num == MAX_RETRY_NUM
+
+      log.info("Access token is expired or invalid, retry #{retry_num} ...")
+
+      refresh_access_token
+
+      # Control call frequency
+      sleep(retry_num * 10)
+      retry_num += 1
+      return request(source_url, params, method, retry_num)
+    elsif json[:errcode] && json[:errcode] != SUCCESS_CODE
+      raise "Request #{url}, errmsg: #{json[:errmsg]}, errcode: #{json[:errcode]}"
+    else
+      json
+    end
+  rescue StandardError => ex
+    log.error("Call wechat api error: #{ex}\n #{ex.backtrace.join("\n")}")
+    json
+  end
+
+  # Remove not UTF-8 encoding
+  def force_encoding(data)
+    data.force_encoding('UTF-8').gsub(/[\u0000-\u001f\u007f\u0080-\u009f]+/, '*')
+  end
+
+  def read_content(res)
+    if res['content-encoding'].present? && res['content-encoding'] == 'gzip'
+      Zlib::GzipReader.new(StringIO.new(res.body), encoding: 'UTF-8').read
+    else
+      res.body
+    end
+  end
+
+  def compose_url(source_url)
+    source_url.include?('?') ? source_url : "#{source_url}?access_token=#{access_token}"
+  end
+
+  def refresh_access_token
+    params = {
+      grant_type: 'client_credential',
+      appid: ENV.fetch('WECHAT_APP_ID'),
+      secret: ENV.fetch('WECHAT_APP_SECRET')
+    }
+
+    res = request("#{BASE_URL}/token?#{params.to_query}", {}, 'GET')
+    save_access_token(res[:access_token]) if res[:access_token]
+    res[:access_token]
+  end
+
+  def save_access_token(token)
+    file = File.new(ACCESS_TOKEN_FILE, 'w')
+    file.write(token)
+  rescue IOError => ex
+    log.error("Write access_token fail: #{ex}")
+  ensure
+    file.close
+  end
+
+  def read_access_token
+    File.exist?(ACCESS_TOKEN_FILE) ? File.read(ACCESS_TOKEN_FILE) : nil
+  end
+
+  def wechat_notify(event, key)
+    File.exist?(NOTIFY_RECIPIENT_FILE) ? YAML.load_file(NOTIFY_RECIPIENT_FILE)[event.to_s][key] : []
+  end
+
+  def log
+    Rails.logger
+  end
+end

data/ocean-wechat.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ocean/wechat/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ocean-wechat"
+  spec.version       = Ocean::Wechat::VERSION
+  spec.authors       = ["bestjane"]
+  spec.email         = ["mr.bestjane@gmail.com"]
+
+  spec.summary       = %q{Wechat api}
+  spec.description   = %q{ Wechat api achieve}
+  spec.homepage      = ""
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  unless spec.respond_to?(:metadata)
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'rest-client', '>= 2.0.2'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: ocean-wechat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bestjane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: " Wechat api achieve"
+email:
+- mr.bestjane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ocean/wechat.rb
+- lib/ocean/wechat/version.rb
+- ocean-wechat.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Wechat api
+test_files: []