userstack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3f64ad1781e50ef9bd02f20b4f6f439186f84aa50d85cd37881b52dfc834e89
+  data.tar.gz: 1c0c1cc717f625a03f9052e4efda3ffed6dd91482ea2e564e4eac1f1f56e70c4
+SHA512:
+  metadata.gz: a2dff6576f8ba8c57d6224408f253ea6dfd5d04a04e4974d8fc448fb2004eb2d67ce86ed773017f386d85706fda0f3bf5986c1ea8570f42f3fea1caf15681857
+  data.tar.gz: 260402a23be9b0b440ebc9adce20d50148c903f56b95f829c3261aaa0aaf89ee9d4c64e6a920c75e5a7540e14580a7693ac31d1f7797a9b1545b0eee63637618

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  Exclude:
+    - Rakefile
+    - bin/*
+    - vendor/**/*
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/userstack/**/*
+    - userstack.gemspec
+
+Metrics/LineLength:
+  Max: 128
+  Exclude:
+    - spec/userstack/**/*
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1
+before_script:
+  - ./bin/validate-target-ruby-version.rb
+  - bundle exec rubocop

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in userstack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 m-maeda-feedforce
+
+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,88 @@
+# Userstack
+
+[![Travis Status](https://img.shields.io/travis/feedforce/userstack.svg?style=flat-square)][travisci]
+[![License](https://img.shields.io/github/license/feedforce/userstack.svg?style=flat-square)][license]
+
+[travisci]: https://travis-ci.org/feedforce/userstack
+[license]: https://github.com/feedforce/userstack/blob/master/LICENSE.txt
+
+This gem provides an access to [Userstack](https://userstack.com://userstack.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'userstack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install userstack
+
+## Usage
+
+1. Instantiate an instance of {Userstack::Client} with a valid Access key.
+
+    ```ruby
+    client = Userstack::Client.new(ACCESS_KEY)
+    ```
+
+2. Parse an useragent.
+
+    ```ruby
+    result = client.parse('an useragent')
+    ```
+
+### Use http
+
+If you are Free plan user, you have to use `http` scheme.
+
+```ruby
+client = Userstack::Client.new(ACCESS_KEY, use_ssl: false)
+result = client.parse('an useragent')
+```
+
+### Legacy response
+
+Userstack supports Useragent API response.
+
+```ruby
+client = Userstack::Client.new(ACCESS_KEY, legacy: true)
+result = client.parse('an useragent')
+```
+
+example response
+```json
+{
+  "data": {
+    "ua_type": "Desktop",
+    "os_name": "macOS 10.14 Mojave",
+    "os_version": "",
+    "browser_name": "Chrome",
+    "browser_version": "71.0.3578.98",
+    "engine_name": "WebKit/Blink",
+    "engine_version": ""
+  }
+}
+```
+
+refs. https://userstack.com/documentation#enable_legacy_format
+
+## 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]/userstack.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "userstack"
+
+# 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/bin/validate-target-ruby-version.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+# rubocop's TargetRubyVersion should be the oldest version in .travis.yml
+
+target = YAML.load_file('.rubocop.yml')['AllCops']['TargetRubyVersion'].to_s
+oldest = YAML.load_file('.travis.yml')['rvm'].min
+
+exit 1 unless oldest.start_with?(target)

data/lib/userstack.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'userstack/version'
+
+# :nodoc:
+module Userstack
+end
+
+require 'userstack/client'
+require 'userstack/uri_builder'

data/lib/userstack/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/https'
+
+module Userstack
+  # A class which wraps calls to Userstack API
+  class Client
+    USER_AGENT = 'Userstack gem/%s' % VERSION
+    private_constant :USER_AGENT
+
+    # @param access_key [String] Userstack Access key
+    # @param use_ssl [Boolean] Use ssl or not
+    # @param legacy [Boolean] Legacy response
+    # @raise [ArgumentError] when `access_key` is invalid
+    # @see https://userstack.com/documentation
+    def initialize(access_key, use_ssl: true, legacy: false)
+      raise ArgumentError, 'Invalid Access key' if access_key.nil? || access_key.empty?
+
+      @access_key = access_key.freeze
+      @use_ssl = use_ssl
+      @legacy = legacy
+      freeze
+    end
+
+    # Parse an useragent using Userstack
+    #
+    # @param useragent [String] an useragent
+    # @return [Hash] a Hash generated by parsing the JSON returned
+    #   from the API call, just `{}` on parsing failure
+    # @raise [ArgumentError] when `useragent` is invalid
+    def parse(useragent)
+      raise ArgumentError, 'Invalid useragent' if useragent.nil? || useragent.empty?
+
+      response = request(useragent)
+      parse_as_json(response.body)
+    end
+
+    private
+
+    attr_reader :access_key, :use_ssl, :legacy
+
+    def request(useragent)
+      uri = UriBuilder.execute(access_key, useragent, use_ssl, legacy)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.get(uri.to_s, 'User-Agent' => USER_AGENT)
+      end
+    end
+
+    def parse_as_json(json_text)
+      json_text ||= '{}'
+      JSON.parse(json_text)
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/lib/userstack/uri_builder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Userstack
+  # A class which builds URI of Userstack api
+  class UriBuilder
+    USERSTACK_API_DOMAIN = 'api.userstack.com'
+    private_constant :USERSTACK_API_DOMAIN
+
+    private_class_method :new
+
+    # @param access_key [String] Userstack Access key
+    # @param useragent [String] useragent
+    # @param use_ssl [Boolean] Use ssl or not
+    # @param legacy [Boolean] Legacy response
+    # @return [URI::HTTP, URI::HTTPS]
+    def self.execute(access_key, useragent, use_ssl, legacy)
+      new(access_key, useragent, use_ssl, legacy).send(:execute)
+    end
+
+    private
+
+    attr_reader :access_key, :useragent, :use_ssl, :legacy
+
+    def initialize(access_key, useragent, use_ssl, legacy)
+      @access_key = access_key.freeze
+      @useragent = useragent.freeze
+      @use_ssl = use_ssl
+      @legacy = legacy
+      freeze
+    end
+
+    def execute
+      fqdn = URI("#{scheme}://#{USERSTACK_API_DOMAIN}/")
+      fqdn.tap do |uri|
+        uri.path = '/detect'
+        uri.query = query
+      end
+    end
+
+    def query
+      q = {
+        access_key: access_key,
+        ua: CGI.escape(useragent)
+      }
+      q[:legacy] = 1 if legacy
+      q.map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    def scheme
+      use_ssl ? 'https' : 'http'
+    end
+  end
+end

data/lib/userstack/version.rb

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

data/userstack.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'userstack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'userstack'
+  spec.version       = Userstack::VERSION
+  spec.authors       = ['Masaki Maeda']
+  spec.email         = ['m-maeda@feedforce.jp']
+
+  spec.summary       = 'Ruby toolkit for working with the Userstack'
+  spec.description   = 'Simple wrapper for the Userstack API https://userstack.com'
+  spec.homepage      = 'https://github.com/feedforce/userstack'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/feedforce/userstack'
+    spec.metadata['changelog_uri'] = 'https://github.com/feedforce/userstack/Chengelog.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.x'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: userstack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masaki Maeda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-24 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: pry
+  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: 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.52.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.x
+- !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 Userstack API https://userstack.com
+email:
+- m-maeda@feedforce.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/validate-target-ruby-version.rb
+- lib/userstack.rb
+- lib/userstack/client.rb
+- lib/userstack/uri_builder.rb
+- lib/userstack/version.rb
+- userstack.gemspec
+homepage: https://github.com/feedforce/userstack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/feedforce/userstack
+  source_code_uri: https://github.com/feedforce/userstack
+  changelog_uri: https://github.com/feedforce/userstack/Chengelog.md
+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.2
+signing_key: 
+specification_version: 4
+summary: Ruby toolkit for working with the Userstack
+test_files: []