vauchar_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0591d688bea72df334e2c414d9a31993ce37ef9ceb8870d5299c33cdca499022'
+  data.tar.gz: 60d4e3a42d4b35be233fab594e78843c132eace77112774b15e8acc658f503d8
+SHA512:
+  metadata.gz: a326a155354a834479f40880b210fb139efb5892e8bf90b30fed45dbdf02c7af2eb6908f868cb37a1f49d348a632af6e2d4d816c64e175c1918ec79b37d454e7
+  data.tar.gz: 970b8a1f6ee7ce02a55c718c891c09df020ddf86a62510734ba659b2b6f4f7740246d5fcb4bbeac6daedc1e764ebca5dc05d7dc53e702e02b761842c75adbfec

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vauchar_api.gemspec
+gemspec
+
+gem 'activeresource'
+gem 'httparty'

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    vauchar_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activeresource (5.1.0)
+      activemodel (>= 5.0, < 7)
+      activemodel-serializers-xml (~> 1.0)
+      activesupport (>= 5.0, < 7)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource
+  bundler (~> 1.16)
+  httparty
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vauchar_api!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Max
+
+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,39 @@
+# VaucharAPI
+
+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/vauchar_api`. 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 'vauchar_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vauchar_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/vauchar_api.
+
+## 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 "vauchar_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/active_resource/connection_ext.rb

@@ -0,0 +1,20 @@
+require "httparty"
+require "vauchar_api/connection"
+
+module ActiveResource
+  class Connection
+    attr_reader :response
+
+    prepend VaucharAPI::Connection::ResponseCapture
+    prepend VaucharAPI::Connection::RequestNotification
+
+    def delete_with_body(path, body = "", headers = {})
+      with_auth do
+        HTTParty.delete("#{site.scheme}://#{site.host}:#{site.port}#{path}", {
+          headers: build_request_headers(headers, :delete, self.site.merge(path)),
+          body: body,
+        })
+      end
+    end
+  end
+end

data/lib/active_resource/custom_methods_ext.rb

@@ -0,0 +1,11 @@
+module ActiveResource
+  module CustomMethods
+    def delete(method_name, options = {}, body = nil)
+      if body.blank?
+        connection.delete(custom_method_element_url(method_name, options), self.class.headers)
+      else
+        connection.delete_with_body(custom_method_element_url(method_name, options), body, self.class.headers)
+      end
+    end
+  end
+end

data/lib/active_resource/formats_ext.rb

@@ -0,0 +1,16 @@
+module ActiveResource
+  module Formats
+    def self.remove_root(data)
+      data = data.with_indifferent_access
+      data = data.key?(:data) ? data[:data] : data
+      p "Formats==================================="
+      p data
+      p "=========================================="
+      if data.is_a?(Hash) && data.keys.size == 1 && data.values.first.is_a?(Enumerable)
+        data.values.first
+      else
+        data
+      end
+    end
+  end
+end

data/lib/vauchar_api/configuration.rb

@@ -0,0 +1,8 @@
+module VaucharAPI
+  class Configuration
+    class << self
+      attr_accessor :merchant_id,
+                    :api_key
+    end
+  end
+end

data/lib/vauchar_api/connection.rb

@@ -0,0 +1,38 @@
+module VaucharAPI
+  class Connection < ActiveResource::Connection
+    attr_reader :response
+
+    module ResponseCapture
+      def handle_response(response)
+        @response = super
+      end
+    end
+
+    include ResponseCapture
+
+    module RequestNotification
+      def request(method, path, *arguments)
+        super.tap do |response|
+          notify_about_request(method, path, response, arguments)
+        end
+      rescue => e
+        notify_about_request(method, path, e.response, arguments) if e.respond_to?(:response)
+        raise
+      end
+
+      def notify_about_request(method, path, response, arguments)
+        p "RequestNotification======================="
+        ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
+          payload[:method] = method
+          payload[:path] = path
+          payload[:response] = response
+          payload[:data] = arguments
+          p payload
+        end
+        p "=========================================="
+      end
+    end
+
+    include RequestNotification
+  end
+end

data/lib/vauchar_api/resources/base.rb

@@ -0,0 +1,53 @@
+require "vauchar_api/version"
+
+module VaucharAPI
+  class Base < ActiveResource::Base
+    self.site = "https://api.vauchar.com"
+    self.include_format_in_path = false
+    self.include_root_in_json = false
+
+    def accepts_attributes; nil; end
+
+    def encode(options = {})
+      same = dup
+      p accepts_attributes
+      same.attributes = same.attributes.slice(*accepts_attributes) if (accepts_attributes)
+      same.send("to_#{self.class.format.extension}", options)
+    end
+
+    class << self
+      def user
+        Configuration.merchant_id
+      end
+
+      def password
+        Configuration.api_key
+      end
+
+      def init_prefix(resource)
+        init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
+      end
+
+      def init_prefix_explicit(resource_type, resource_id)
+        self.prefix = "/#{resource_type}/:#{resource_id}/"
+
+        define_method resource_id.to_sym do
+          @prefix_options[resource_id]
+        end
+      end
+    end
+
+    private
+
+    def keep_prefix_options
+      prefix_options = @prefix_options
+      yield
+      @prefix_options = prefix_options
+      self
+    end
+
+    def only_id
+      encode(only: :id, include: [], methods: [])
+    end
+  end
+end

data/lib/vauchar_api/resources/brand.rb

@@ -0,0 +1,25 @@
+module VaucharAPI
+  # ==== Examples
+  # [Create]
+  # new_brand = VaucharAPI::Brand.new(name: "test by max", email: "max@gmail.com")
+  # new_brand.save
+  #
+  # [Read]
+  # brand = VaucharAPI::Brand.find("brn-15510817645c73a12406a95")
+  # brands = VaucharAPI::Brand.all
+  #
+  # [Update]
+  # brand = VaucharAPI::Brand.find("brn-15510817645c73a12406a95")
+  # brand.name = "test update"
+  # brand.save
+  #
+  # [Delete]
+  # brand = VaucharAPI::Brand.find("brn-15510817645c73a12406a95")
+  # brand.destroy
+
+  class Brand < Base
+    def accepts_attributes
+      [:name, :email]
+    end
+  end
+end

data/lib/vauchar_api/resources/customer.rb

@@ -0,0 +1,33 @@
+module VaucharAPI
+  # ==== Examples
+  # [Create]
+  # new_customer = VaucharAPI::Customer.new({
+  #   user_id: "12345",
+  #   name: "max",
+  #   email: "max@gmail.com",
+  #   phone: "+886912345678",
+  #   birthday: "1990-03-25",
+  # })
+  # new_customer.save
+  #
+  # [Read]
+  # customer = VaucharAPI::Customer.find("cust-15507323535c6e4c416c697")
+  # customers = VaucharAPI::Customer.all
+  #
+  # [Update]
+  # customer = VaucharAPI::Customer.find("cust-15507323535c6e4c416c697")
+  # customer.name = "test update"
+  # customer.save
+  #
+  # [Delete]
+  # customer = VaucharAPI::Customer.find("cust-15507323535c6e4c416c697")
+  # customer.destroy
+
+  class Customer < Base
+    def accepts_attributes
+      accepts = [:name, :email, :phone, :birthday, :created, :last_seen, :total_purchase]
+      accepts.push :user_id if self.new?
+      accepts
+    end
+  end
+end

data/lib/vauchar_api/resources/customer_deal.rb

@@ -0,0 +1,57 @@
+module VaucharAPI
+  # ==== Examples
+  # [Read]
+  # deals = VaucharAPI::CustomerDeal.find(:all, params: {customer_id: "cust-15507323535c6e4c416c697"})
+  #
+  # [Redemptions]
+  # deals[1].redemptions
+  # deals[1].voucher.voucher_code # => "DA2C2J65JFVNY"
+  #
+  # [Validate]
+  # deals[1].validate
+
+  class CustomerDeal < Base
+    init_prefix :customer
+    self.collection_name = "deals"
+
+    def customer_id
+      @prefix_options[:customer_id]
+    end
+
+    def id
+      self.data.id
+    end
+
+    def redemptions
+      keep_prefix_options do
+        resource = post(:redemptions, {}, only_id)
+        data = self.class.format.decode(resource.body)
+        load({voucher: data}, false, true)
+      end
+    end
+
+    def validate
+      keep_prefix_options do
+        resource = get(:validate, {})
+        load({data: resource}, false, true)
+      end
+    end
+
+    # ==== Examples
+    # voucher = VaucharAPI::CustomerDeal.redemptions(
+    #   {},
+    #   params: {
+    #     customer_id: "cust-15507323535c6e4c416c697",
+    #     id: "en-deal-15499589715c627f3b57837",
+    #   },
+    # )
+    #
+    # def self.redemptions(*args)
+    #   options = {:refund => args[0]}
+    #   params = options.merge(args[1][:params]) if args[1] && args[1][:params]
+    #   self.prefix = "/customers/#{params[:customer_id]}/"
+    #   resource = post("#{params[:id]}/redemptions", {}, options.to_json)
+    #   instantiate_record(format.decode(resource.body), {})
+    # end
+  end
+end

data/lib/vauchar_api/resources/deal.rb

@@ -0,0 +1,36 @@
+module VaucharAPI
+  # ==== Examples
+  # [Create]
+  # new_deal = VaucharAPI::Deal.new({
+  #   title: "max_test",
+  #   brand_id: "brn-15507182295c6e1515a956a",
+  #   voucher_data: {
+  #     value: "30",
+  #     value_unit: "value",
+  #     currency: "USD",
+  #     expiry_time_type: "relative",
+  #     expiry_time: "10",
+  #     expiry_time_unit: "hours",
+  #   },
+  # })
+  # new_deal.save
+  #
+  # [Read]
+  # deal = VaucharAPI::Deal.find("en-deal-15499589715c627f3b57837")
+  # deals = VaucharAPI::Deal.all
+  #
+  # [Delete]
+  # deal = VaucharAPI::Deal.find("en-deal-15499589715c627f3b57837")
+  # deal.destroy
+  #
+  # [Find By Brand]
+  # deals = VaucharAPI::Deal.find(:all, params: {brand_id: "brn-15507182295c6e1515a956a"})
+
+  class Deal < Base
+    self.prefix = "/engage/"
+
+    # def accepts_attributes
+    #   [:name, :email]
+    # end
+  end
+end

data/lib/vauchar_api/resources/list.rb

@@ -0,0 +1,42 @@
+module VaucharAPI
+  # ==== Examples
+  # [Create]
+  # new_list = VaucharAPI::List.new(name: "max list", brand_id: "brn-15507182295c6e1515a956a")
+  # new_list.save
+  #
+  # [Read]
+  # list = VaucharAPI::List.find("list-15508273755c6fbf6fc8ac7")
+  # lists = VaucharAPI::List.all
+  #
+  # [Update]
+  # list = VaucharAPI::List.find("list-15508273755c6fbf6fc8ac7")
+  # list.name = "Max update"
+  # list.save
+  #
+  # [Delete]
+  # list = VaucharAPI::List.find("list-15508273755c6fbf6fc8ac7")
+  # list.destroy
+  #
+  # [Customers]
+  # list = VaucharAPI::List.find("list-15502036875c663b27600fe")
+  # list.get(:customers);
+  #
+  # [Add Customers]
+  # list = VaucharAPI::List.find("list-15502036875c663b27600fe")
+  # list.post(:customers, {}, {customers: ["cust-15508280955c6fc23f7f807", "cust-15507323535c6e4c416c697"]}.to_json)
+  #
+  # [Delete Customers]
+  # list = VaucharAPI::List.find("list-15502036875c663b27600fe")
+  # list.delete(:customers, {}, {customers: ["cust-15508280955c6fc23f7f807", "cust-15507323535c6e4c416c697"]})
+  #
+  # [Find By Brand]
+  # lists = VaucharAPI::List.find(:all, params: {brand_id: "brn-15507182295c6e1515a956a"})
+
+  class List < Base
+    self.prefix = "/engage/"
+
+    def accepts_attributes
+      [:name, :brand_id]
+    end
+  end
+end

data/lib/vauchar_api/resources/verify_credentials.rb

@@ -0,0 +1,5 @@
+module VaucharAPI
+  class VerifyCredentials < Base
+    self.element_name = "verifycredentials"
+  end
+end

data/lib/vauchar_api/resources.rb

@@ -0,0 +1,2 @@
+require "vauchar_api/resources/base"
+Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) }

data/lib/vauchar_api/version.rb

@@ -0,0 +1,3 @@
+module VaucharAPI
+  VERSION = "0.1.1"
+end

data/lib/vauchar_api.rb

@@ -0,0 +1,19 @@
+require "http_logger"
+require "vauchar_api/configuration"
+require "vauchar_api/version"
+
+require "active_resource"
+require "active_resource/formats_ext"
+
+HttpLogger.log_request_body = true
+
+module VaucharAPI
+  def self.config
+    yield Configuration
+  end
+end
+
+require "vauchar_api/resources"
+require "vauchar_api/connection"
+require "active_resource/connection_ext"
+require "active_resource/custom_methods_ext"

data/vauchar_api.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vauchar_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "vauchar_api"
+  spec.version = VaucharAPI::VERSION
+  spec.authors = ["Max"]
+  spec.email = ["max.liu0325@gmail.com"]
+
+  spec.summary = %q{Write a short summary, because RubyGems requires one.}
+  spec.description = %q{Write a longer description or delete this line.}
+  # spec.homepage = "https://rubygems.org/gems/example"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) 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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: vauchar_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Max
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-25 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+description: Write a longer description or delete this line.
+email:
+- max.liu0325@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/active_resource/connection_ext.rb
+- lib/active_resource/custom_methods_ext.rb
+- lib/active_resource/formats_ext.rb
+- lib/vauchar_api.rb
+- lib/vauchar_api/configuration.rb
+- lib/vauchar_api/connection.rb
+- lib/vauchar_api/resources.rb
+- lib/vauchar_api/resources/base.rb
+- lib/vauchar_api/resources/brand.rb
+- lib/vauchar_api/resources/customer.rb
+- lib/vauchar_api/resources/customer_deal.rb
+- lib/vauchar_api/resources/deal.rb
+- lib/vauchar_api/resources/list.rb
+- lib/vauchar_api/resources/verify_credentials.rb
+- lib/vauchar_api/version.rb
+- vauchar_api.gemspec
+homepage: 
+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: Write a short summary, because RubyGems requires one.
+test_files: []