grammarbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 676a1d2e43b3f4516f37705451e072b0881d697df9dca7d04f61ccc802947719
+  data.tar.gz: 273931a8fbcf2adee0d2d7b828241594238463f5711b3752c16e06af3bcfd3d2
+SHA512:
+  metadata.gz: cfdd8edb477df11c001fd84593a56775b63578e7a03579582a6406ac818fa15a550d9e92748dd761cd788d5c28bc655853d59460ebf0de2a1a9659d7b34f49e2
+  data.tar.gz: ac1c13144d8910bb644f5cbff562bc9a84e20e7c85bcd772b0a13de4259fa59198f0b0c596851b23d38f51ec444c8fcec93c27189e7931c68c79e320065630df

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+grammarbot

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.3

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :test do
+  gem 'pry'
+  gem 'rspec'
+end
+
+# Specify your gem's dependencies in grammarbot-rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Timur Valeev
+
+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,49 @@
+# Grammarbot
+
+A Ruby API client for [GrammrBot API](https://www.grammarbot.io/quickstart)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grammarbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grammarbot
+
+## Usage
+Client initialization, `api_key`, `language` and `base_uri` are optional and could be ommited, or defined later
+
+    gbot = Grammarbot::Client.new(api_key: 'grammarbot_default_key', language: 'en-US', base_uri: 'http://api.grammarbot.io')
+
+    gbot.api_key = 'new_api_key'
+    gbot.language = 'en-GB'
+    gbot.base_uri = 'http://pro.grammarbot.io'
+
+Don't want to check the key into source control? Put the key on the GRAMMARBOT_API_KEY environment variable!
+
+Simple example
+
+    result = gbot.check("I can't remember how to go their.")
+
+    result.language.code # => 'en-US'
+    result.matches.size # => 1
+    result.matches.first.message # => "Statistics suggests that 'there' (as in 'Is there an answer?') might be the correct word here, not 'their' (as in 'It’s not their fault.'). Please check."
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GrammarBot-API/grammarbot-rb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'grammarbot'
+
+# 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.
+
+require 'pry'
+Pry.start

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/grammarbot.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grammarbot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grammarbot'
+  spec.version       = Grammarbot::VERSION
+  spec.authors       = ['Timur Valeev']
+  spec.email         = ['kibenimatik@yandex.ru']
+
+  spec.summary       = 'Client library for GrammarBot API'
+  spec.description   = <<~DESC
+    Gem wrapper for GrammarBot API for detecting grammar and spelling errors
+  DESC
+  spec.homepage      = 'https://github.com/GrammarBot-API/grammarbot-rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 'httparty'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/grammarbot.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'grammarbot/version'
+require 'grammarbot/client'
+
+module Grammarbot
+end

data/lib/grammarbot/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Grammarbot
+  class Client
+    include HTTParty
+
+    # Initializes API client
+    # @param api_key [String] GrammarBot API key, optional
+    # @param language [String] language in which to check, optional
+    # @param base_uri [String] GrammarBot API server url, optional
+    def initialize(api_key: nil, language: 'en-US', base_uri: 'http://api.grammarbot.io')
+      api_key ||= ENV['GRAMMARBOT_API_KEY'] || 'ruby-default'
+      self.class.base_uri base_uri
+      self.class.default_params api_key: api_key, language: language
+    end
+
+    # Submits text for grammar and spelling errors to GrammarBot
+    # @param text [String] text to submit
+    # @return [Object] GrammarBot response
+    def check(text)
+      request(:get, '/v2/check', query: { text: text })
+    end
+
+    # Change client api_key
+    # @param new_api_key [String] API key
+    def api_key=(new_api_key)
+      self.class.default_params[:api_key] = new_api_key
+    end
+
+    # Change language for text check
+    # @param lang [String] language code
+    def language=(lang)
+      self.class.default_params[:language] = lang
+    end
+
+    # Change client base_uri
+    # @param uri [String] API endpoint base uri
+    def base_uri=(uri)
+      self.class.base_uri(uri)
+    end
+
+    private
+
+    def request(http_method, path, query: {})
+      response = self.class.send(http_method, path, query: query)
+      JSON.parse response.body, object_class: OpenStruct
+    end
+  end
+end

data/lib/grammarbot/version.rb

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: grammarbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timur Valeev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 'Gem wrapper for GrammarBot API for detecting grammar and spelling errors
+
+'
+email:
+- kibenimatik@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grammarbot.gemspec
+- lib/grammarbot.rb
+- lib/grammarbot/client.rb
+- lib/grammarbot/version.rb
+homepage: https://github.com/GrammarBot-API/grammarbot-rb
+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.8
+signing_key: 
+specification_version: 4
+summary: Client library for GrammarBot API
+test_files: []