shanon 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1474207b017d79213bc4ea7d893c602097cac62
+  data.tar.gz: a88bdc20f92aa93433b843faec3d9a956aa60c24
+SHA512:
+  metadata.gz: fdcd18eb93675f19d4f50f28cd418f1f04be8c843135d6c9dc8a0bb5571d02a3bef535c026d65a45c626003d46d87091121aaa1a75db94519de044a45b76e4da
+  data.tar.gz: 4c82c2b56590b6d405b095cd21fad4533e89b02a07c07edd1ef182f18b1b8adeac8248796388dfc3ebc94249a630792e9f8cb206b876c888d4283ab32a7a470d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install:
+  - gem update --system
+  - gem update bundler

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 github@takuyan.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 shanon-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Takuya Kato
+
+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,56 @@
+# Shanon
+
+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/shanon`. 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 'shanon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shanon
+
+## Usage
+
+```ruby
+Shanon.configure do |config|
+  config.api_key = 'your_consumer_api_key'
+  config.fqdn = 'your-consumer-name.smktg.jp'
+  config.password = 'your_consumer_password'
+  config.secret_key = 'your_consumer_secret_key'
+end
+
+client = Shanon::Clients::AuthenticationClient.new
+puts client.get # => token
+
+client = Shanon::Clients::VisitorClient.new
+puts client.get # => visitors
+```
+
+## 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/takuyan/shanon-ruby. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Shanon project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/takuyan/shanon-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = true
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shanon/ruby'
+
+# 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/shanon/abstract_client.rb

@@ -0,0 +1,55 @@
+require 'digest/sha1'
+require 'openssl'
+
+module Shanon
+  class AbstractClient
+    attr_reader :secrets, :conn, :token
+
+    def initialize
+      @secrets = get_secrets
+      @conn = build_client
+      @token = get_token
+    end
+
+    private
+
+    def get_secrets
+      {
+        api_key: Shanon.config.api_key,
+        fqdn: Shanon.config.fqdn,
+        password: Shanon.config.password,
+        secret_key: Shanon.config.secret_key
+      }
+    end
+
+    def build_client
+      fqdn = secrets[:fqdn]
+      host = %(https://#{fqdn})
+
+      ::Faraday.new(url: host) do |builder|
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::Logger
+        builder.use Faraday::Adapter::NetHttp
+      end
+    end
+
+    def get_token
+      # override by Authenticatable
+    end
+
+    def params_with_signature(opts={})
+      seeds = { api_key: secrets[:api_key] }.merge!(opts)
+      seeds.merge!(token: token) if token
+
+      base = seeds.sort.reduce('') do |s, (k, v)|
+        s.concat %(#{k}#{v})
+      end
+
+      seeds.merge!({ api_sig: get_signature(base) })
+    end
+
+    def get_signature(base)
+      ::OpenSSL::HMAC.hexdigest('sha1', secrets[:secret_key], base)
+    end
+  end
+end

data/lib/shanon/authenticatable.rb

@@ -0,0 +1,7 @@
+module Shanon
+  module Authenticatable
+    def get_token
+      @token = Shanon::Clients::AuthenticationClient.new.get
+    end
+  end
+end

data/lib/shanon/clients/authentication_client.rb

@@ -0,0 +1,19 @@
+module Shanon
+  module Clients
+    class AuthenticationClient < Shanon::AbstractClient
+      PATH = '/services/rest/authentication'.freeze
+
+      def get
+        params = params_with_signature(password: secrets[:password])
+        response = conn.get(PATH, params)
+        parse(response.body)
+      end
+
+      private
+
+      def parse(xml)
+        ::Ox.parse(xml).Response.Token.text
+      end
+    end
+  end
+end

data/lib/shanon/clients/visitor_client.rb

@@ -0,0 +1,26 @@
+module Shanon
+  module Clients
+    class VisitorClient < Shanon::AbstractClient
+      include Authenticatable
+
+      PATH = '/services/rest/visitor'.freeze
+
+      # opts = {
+      #   search_key1: 'DateRegist',
+      #   search_operator1: 'lt',
+      #   search_value1: '2018-01-01T00:00:00+09:00'
+      # }
+      def get(opts={})
+        params = params_with_signature(opts)
+        response = conn.get PATH, params
+        parse(response.body)
+      end
+
+      private
+
+      def parse(xml)
+        ::Ox.parse(xml)
+      end
+    end
+  end
+end

data/lib/shanon/config.rb

@@ -0,0 +1,35 @@
+module Shanon
+  # Configures global settings for Shanon
+  #   Shanon.configure do |config|
+  #     config.api_key    = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
+  #     config.fqdn       = 'aaaa-bbbb.smktg.jp'
+  #     config.password   = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
+  #     config.secret_key = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
+  #   end
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @_config ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :api_key, :fqdn, :password, :secret_key
+    attr_writer :param_name
+
+    def initialize
+      @api_key    = nil
+      @fqdn       = nil
+      @password   = nil
+      @secret_key = nil
+    end
+
+    # If param_name was given as a callable object, call it when returning
+    def param_name
+      @param_name.respond_to?(:call) ? @param_name.call : @param_name
+    end
+  end
+end

data/lib/shanon/version.rb

@@ -0,0 +1,3 @@
+module Shanon
+  VERSION = '0.1.2'
+end

data/lib/shanon.rb

@@ -0,0 +1,11 @@
+require 'shanon/version'
+
+require 'shanon/config'
+require 'shanon/abstract_client'
+require 'shanon/authenticatable'
+require 'shanon/clients/authentication_client'
+require 'shanon/clients/visitor_client'
+
+module Shanon
+  # Your code goes here...
+end

data/shanon-ruby.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shanon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shanon'
+  spec.version       = Shanon::VERSION
+  spec.authors       = ['Takuya Kato']
+  spec.email         = ['g@takuyan.com']
+
+  spec.summary       = %q{Client for accessing Shanon Marketing Platform APIs}
+  spec.description   = %q{Client for accessing Shanon Marketing Platform APIs}
+  spec.homepage      = 'https://github.com/takuyan/shanon-ruby'
+  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 'faraday'
+  spec.add_dependency 'ox'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: shanon
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Takuya Kato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: ox
+  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.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: test-unit
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: Client for accessing Shanon Marketing Platform APIs
+email:
+- g@takuyan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shanon.rb
+- lib/shanon/abstract_client.rb
+- lib/shanon/authenticatable.rb
+- lib/shanon/clients/authentication_client.rb
+- lib/shanon/clients/visitor_client.rb
+- lib/shanon/config.rb
+- lib/shanon/version.rb
+- shanon-ruby.gemspec
+homepage: https://github.com/takuyan/shanon-ruby
+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.13
+signing_key: 
+specification_version: 4
+summary: Client for accessing Shanon Marketing Platform APIs
+test_files: []