line_notify_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33b7a3c966ce4988bca357dcaaf18e08efe82f4065da2e8a737b9ecdff5daf0c
+  data.tar.gz: d9b12267a2265cf8263001e4c2c002e1ac843f3312669700e9d574f22e08b566
+SHA512:
+  metadata.gz: b29f912a3cdcf243c49ce14af1fd0f0286fd66a2112f90b28691b0b2a2b74becbc80ab03e9a91c41deaa39b014bd12fe6635d18335f6bbc7b429f50a5e8c06c4
+  data.tar.gz: c00b02f04756fdad7061ad426382ea3e261f1b29b8592fd628f54f3487a5dd8ff83cce2bf18a97622a320844ae673aa8ef91745cff1c4312a189e4978eb03f3e

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+
+group :development, :test do
+  gem 'byebug', '~> 10.0'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    line_notify_client (1.0.0)
+      faraday (~> 0.13)
+      faraday_middleware (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (1.0.0)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (4.0.2)
+    rake (10.5.0)
+    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)
+    safe_yaml (1.0.5)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 10.0)
+  line_notify_client!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Findy Inc. (ファインディ)
+
+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,45 @@
+# line_notify_client
+
+LINE Notify API client library, written in Ruby https://notify-bot.line.me/doc/en/
+
+## Install
+
+```bash
+gem install line_notify_client
+```
+
+or
+
+```
+# Gemfile
+gem 'line_notify_client'
+```
+
+## Library
+
+```ruby
+require 'line_notify_client'
+
+# OAuth2 Auhentication Documentation: https://notify-bot.line.me/doc/en/
+access_token = 'access token from LINE Notify oauth2 authentication'
+
+# new client
+client = LineNotifyClient.new(access_token)
+
+# Sends notifications to users or groups are related to an access token.
+client.notify('message')
+
+# Check the validity of an access token.
+client.status
+
+# Disable an access token
+client.revoke
+```
+
+## Development
+
+* Run rspec
+
+```ruby
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/line_notify_client.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'line_notify_client/error'
+require 'line_notify_client/http_client'
+require 'line_notify_client/response'
+require 'line_notify_client/version'
+
+module LineNotifyClient
+  def self.new(access_token)
+    LineNotifyClient::HttpClient.new(access_token)
+  end
+end

data/lib/line_notify_client/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LineNotify
+  # Custom error class for rescuing from all LINE Notify errors
+  class Error < StandardError
+  end
+
+  # Raised when HTTP request timeout
+  class TimeoutError < Error; end
+end

data/lib/line_notify_client/http_client.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module LineNotifyClient
+  # ## LineNotify::Client
+  # A class for LINE Notify API client.
+  #
+  class HttpClient
+    HOST = 'notify-api.line.me'
+    ACCEPT = 'application/json'
+    USER_AGENT = 'LineNotify Ruby'
+    HEADERS = { 'Accept' => ACCEPT, 'User-Agent' => USER_AGENT }.freeze
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    # ### LineNotify::Client#notify
+    # Sends notifications to users or groups that are related to an access token.
+    #
+    # POST https://notify-api.line.me/api/notify
+    def notify(message, options = {})
+      params = { message: message }.merge(options)
+      post('/api/notify', params, options)
+    end
+
+    # ### LineNotify::Client#status
+    # Check the validity of an access token.
+    #
+    # GET https://notify-api.line.me/api/status
+    def status
+      get('/api/status')
+    end
+
+    # ### LineNotify::Client#revoke
+    # Disable an access token.
+    #
+    # POST https://notify-api.line.me/api/revoke
+    def revoke
+      post('/api/revoke')
+    end
+
+    private
+
+    def get(path, params = nil, headers = nil)
+      request(:get, path, params, headers)
+    end
+
+    def post(path, params = nil, headers = nil)
+      request(:post, path, params, headers)
+    end
+
+    def request(http_method, path, params, headers)
+      faraday_response = connection.send(http_method, path, params, headers)
+      LineNotify::Response.new(faraday_response)
+    rescue Faraday::Error::TimeoutError => e
+      raise LineNotify::TimeoutError, e.message
+    rescue Faraday::Error => e
+      raise LineNotify::Error, e.message
+    end
+
+    def connection
+      @connection ||= Faraday.new(faraday_client_options) do |builder|
+        builder.options.timeout = 5 # 5 seconds
+        builder.request :url_encoded
+        builder.request :json
+        builder.response :json
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def faraday_client_options
+      {
+        url: "https://#{HOST}",
+        ssl: { verify: true },
+        headers: faraday_headers
+      }
+    end
+
+    def faraday_headers
+      HEADERS.merge('Authorization' => "Bearer #{@access_token}")
+    end
+  end
+end

data/lib/line_notify_client/response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module LineNotify
+  # ## LineNotify::Response
+  # A class for response data returned from API.
+  #
+  class Response
+    HTTP_STATUS_SUCCESS = 200
+    HTTP_STATUS_BAD_REQUEST = 400
+    HTTP_STATUS_TOKEN_EXPIRED = 401
+    HTTP_STATUS_INTERNAL_ERROR = 500
+
+    def initialize(faraday_response)
+      @raw_body = faraday_response.body
+      @raw_headers = faraday_response.headers
+      @raw_status = faraday_response.status
+    end
+
+    # ### LineNotify::Response#body
+    # Returns response body returned from API as a `Hash`.
+    #
+    # ```rb
+    # response.body #=> { ... }
+    # ```
+    #
+    def body
+      @raw_body
+    end
+
+    # ### LineNotify::Response#headers
+    # Returns response headers returned from API as a `Hash`.
+    #
+    # ```rb
+    # response.headers #=> { "Content-Type" => "application/json" }
+    # ```
+    #
+    def headers
+      @headers ||= @raw_headers.inject({}) do |result, (key, value)|
+        result.merge(key.split("-").map(&:capitalize).join("-") => value)
+      end
+    end
+
+    # ### LineNotify::Response#status
+    # Returns response status code returned from API as a `Integer`.
+    #
+    # ```rb
+    # response.status #=> 200
+    # ```
+    #
+    def status
+      @raw_status
+    end
+
+    # ### LineNotify::Response#status_message
+    # Returns response status message returned from API as a `String`.
+    #
+    # ```rb
+    # response.status_message #=> "OK"
+    # ```
+    #
+    def status_message
+      Rack::Utils::HTTP_STATUS_CODES[status]
+    end
+
+    # ### LineNotify::Response#success?
+    # Returns success boolean value from API as a `TrueClass` or `FalseClass`.
+    #
+    # ```rb
+    # response.success? #=> true
+    # ```
+    #
+    def success?
+      status == HTTP_STATUS_SUCCESS
+    end
+
+    # ### LineNotify::Response#status
+    # Returns response status from API as a `TrueClass` or `FalseClass`.
+    #
+    # ```rb
+    # response.success? #=> true
+    # ```
+    #
+    def error?
+      !success?
+    end
+
+    def bad_request?
+      status == HTTP_STATUS_BAD_REQUEST
+    end
+
+    def token_expired?
+      status == HTTP_STATUS_TOKEN_EXPIRED
+    end
+
+    def internal_error?
+      status == HTTP_STATUS_INTERNAL_ERROR
+    end
+  end
+end

data/lib/line_notify_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LineNotify
+  VERSION = '1.0.0'
+end

data/line_notify_client.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'line_notify_client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'line_notify_client'
+  s.version     = LineNotify::VERSION
+  s.authors     = ['Shojiro Yanagisawa']
+  s.email       = ['nipe0324@gmail.com']
+  s.homepage    = 'https://github.com/Findy/line_notify_client'
+  s.summary     = 'LINE Notify API client library'
+  s.description = 'LINE Notify API client library'
+  s.licenses    = ['MIT']
+
+  s.files       = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday', '~> 0.13'
+  s.add_dependency 'faraday_middleware', '~> 0.12'
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: line_notify_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shojiro Yanagisawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !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: webmock
+  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'
+description: LINE Notify API client library
+email:
+- nipe0324@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/line_notify_client.rb
+- lib/line_notify_client/error.rb
+- lib/line_notify_client/http_client.rb
+- lib/line_notify_client/response.rb
+- lib/line_notify_client/version.rb
+- line_notify_client.gemspec
+homepage: https://github.com/Findy/line_notify_client
+licenses:
+- MIT
+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.6
+signing_key: 
+specification_version: 4
+summary: LINE Notify API client library
+test_files: []