useragent_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa7b4380698ff6a3af222de67b3bd4dea389204e
+  data.tar.gz: '0419a791e1514c983b690d27418c6ac1358ef5dd'
+SHA512:
+  metadata.gz: a9dadd10d7ba6dfed43cf651c7bff342a036d0f75489ab640d3918d93050f70b6889948b8f96d49de086b86a73f16b6b0954065b1567bc80942a497bc5ea640d
+  data.tar.gz: c5df77933eb177cec97a6f3832254256a523f056fdc8fe8cb1e4787ffafb1e2c673ec8595c7a830d02d812e4b78d7182b2b5f3af3cc24a1dd53049b3dde17bc9

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - Rakefile
+    - bin/*
+    - vendor/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/useragent_api/**/*
+
+Metrics/LineLength:
+  Max: 128
+  Exclude:
+    - spec/useragent_api/**/*
+
+Style/FormatString:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6
+before_script: bundle exec rubocop

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 masutaka@feedforce.jp. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in useragent_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Takashi Masuda
+
+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,53 @@
+# UseragentApi
+
+[![Build Status](https://travis-ci.org/feedforce/useragent_api.svg?branch=master)][travisci]
+
+[travisci]: https://travis-ci.org/feedforce/useragent_api
+
+This gem provides an access to [UseragentAPI](https://useragentapi.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'useragent_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install useragent_api
+
+## Usage
+
+1. Instantiate an instance of {UseragentApi::Client} with a valid API key.
+
+    ```ruby
+    client = UseragentApi::Client.new(API_KEY)
+    ```
+
+2. Parse an useragent.
+
+    ```ruby
+    result = client.parse('an useragent')
+    ```
+
+## 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/masutaka/useragent_api. 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](http://opensource.org/licenses/MIT).
+

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 "useragent_api"
+
+# 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/useragent_api.rb

@@ -0,0 +1,7 @@
+require 'useragent_api/version'
+
+# :nodoc:
+module UseragentApi
+end
+
+require 'useragent_api/client'

data/lib/useragent_api/client.rb

@@ -0,0 +1,58 @@
+require 'cgi'
+require 'json'
+require 'net/https'
+
+module UseragentApi
+  # A class which wraps calls to UseragentAPI
+  class Client
+    # @param api_key [String] UseragentAPI API key
+    # @raise [ArgumentError] when `api_key` is invalid
+    # @see https://useragentapi.com/docs/v4
+    def initialize(api_key)
+      raise ArgumentError, 'invalid API key' if api_key.empty?
+      @api_key = api_key.freeze
+      freeze
+    end
+
+    # @return [String] Returns the api key
+    attr_reader :api_key
+
+    # Parse an useragent using UseragenAPI
+    #
+    # @param useragent [String] an useragent
+    # @return [Hash] a Hash generated by parsing the JSON returned
+    #   from the API call, just `{}` on parsing failure
+    def parse(useragent)
+      response = request(useragent)
+      parse_as_json(response.body)
+    end
+
+    USERAGENT_API_FQDN = URI('https://useragentapi.com/')
+    private_constant :USERAGENT_API_FQDN
+
+    USER_AGENT = 'UseragentApi gem/%s' % VERSION
+    private_constant :USER_AGENT
+
+    private
+
+    def request(useragent)
+      uri = request_uri(useragent)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.get(uri.path, 'User-Agent' => USER_AGENT)
+      end
+    end
+
+    def request_uri(useragent)
+      USERAGENT_API_FQDN.dup.tap do |uri|
+        uri.path = '/api/v4/json/%s/%s' % [api_key, CGI.escape(useragent)]
+      end
+    end
+
+    def parse_as_json(json_text)
+      json_text ||= '{}'
+      JSON.parse(json_text)
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/lib/useragent_api/version.rb

@@ -0,0 +1,3 @@
+module UseragentApi
+  VERSION = '0.1.0'.freeze
+end

data/useragent_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'useragent_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'useragent_api'
+  spec.version       = UseragentApi::VERSION
+  spec.authors       = ['Takashi Masuda']
+  spec.email         = ['masutaka.net@gmail.com']
+
+  spec.summary       = 'Ruby toolkit for working with the UserAgent API'
+  spec.description   = 'Simple wrapper for the UserAgent API https://useragentapi.com/'
+  spec.homepage      = 'https://github.com/feedforce/useragent_api'
+  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_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: useragent_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Masuda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-15 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !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: Simple wrapper for the UserAgent API https://useragentapi.com/
+email:
+- masutaka.net@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/useragent_api.rb
+- lib/useragent_api/client.rb
+- lib/useragent_api/version.rb
+- useragent_api.gemspec
+homepage: https://github.com/feedforce/useragent_api
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Ruby toolkit for working with the UserAgent API
+test_files: []