vindi 0.0.1

data/lib/vindi/rest/product.rb

@@ -0,0 +1,51 @@
+module Vindi
+  module Rest
+
+    # Methods for the products API
+    # @see https://vindi.github.io/api-docs/dist/#!/products
+    module Product
+
+      # List products for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of products for a merchant.
+      # @example Get all products from merchant vindi
+      def list_products(options = {})
+        get('products', options)[:products]
+      end
+      
+      # Get a single product from a merchant
+      #
+      # @param product_id [Integer] ID of the product
+      # @return [Hash] The product you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/products/GET_version_products_id_format
+      # @example Get product #2 from vindi
+      #   client.product(2)
+      def product(product_id, options = {})
+        get("products/#{product_id}", options)[:product]
+      end
+
+      # Create a product for a merchant vindi
+      # 
+      # @option options [Hash] :options product attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/products/POST_version_products_format 
+      # @return [Hash] The product created
+      # @example Create a product for a merchant vindi
+      #   client.create_product(name: 'My product', interval: 12)
+      def create_product(options = {})
+        post('products', options)[:product]
+      end
+
+      # Edit a product
+      #
+      # @params product_id [Integer] ID of the product
+      # @option options [Hash] :options product attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/products/PUT_version_products_id_format
+      # @example Update product #2
+      #   client.update_product(2, name: 'My product', interval: 3)
+      def update_product(product_id, options = {})
+        put("products/#{product_id}", options)[:product]
+      end
+    end
+  end
+end

data/lib/vindi/rest/product_item.rb

@@ -0,0 +1,54 @@
+module Vindi
+  module Rest
+
+    # Methods for the product_items API
+    # @see https://vindi.github.io/api-docs/dist/#!/product_items
+    module ProductItem
+
+      # Get a single product_item from a merchant
+      #
+      # @param product_item_id [Integer] ID of the product_item
+      # @return [Hash] The product_item you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/product_items/GET_version_product_items_id_format
+      # @example Get product_item #2 from vindi
+      #   client.product_item(2)
+      def product_item(product_item_id, options = {})
+        get("product_items/#{product_item_id}", options)[:product_item]
+      end
+
+      # Create a product_item for a merchant vindi
+      # 
+      # @option options [Hash] :options product_item attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/product_items/POST_version_product_items_format 
+      # @return [Hash] The product_item created
+      # @example Create a product_item for a merchant vindi
+      #   client.create_product_item(product_id: 26, quantity: 1)
+      def create_product_item(options = {})
+        post('product_items', options)[:product_item]
+      end
+
+      # Edit a product_item
+      #
+      # @params product_item_id [Integer] ID of the product_item
+      # @option options [Hash] :options product_item attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/product_items/PUT_version_product_items_id_format
+      # @example Update product_item #2
+      #   client.update_product_item(2, quantity: 2)
+      def update_product_item(product_item_id, options = {})
+        put("product_items/#{product_item_id}", options)[:product_item]
+      end
+
+      # Delete a product_item from merchant vindi
+      #
+      # @params product_item_id [Integer] ID of the product_item
+      # @option options [Hash] :options product_item attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/product_items/DELETE_version_product_items_id_format
+      # @example Delete product_item #2
+      #   client.delete_product_item(2)
+      def delete_product_item(product_item_id, options = {})
+        delete("product_items/#{product_item_id}", options)[:product_item]
+      end
+    end
+  end
+end

data/lib/vindi/rest/role.rb

@@ -0,0 +1,18 @@
+module Vindi
+  module Rest
+
+    # Methods for the roles API
+    # @see https://vindi.github.io/api-docs/dist/#!/roles
+    module Role
+
+      # List roles for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of roles for a merchant.
+      # @example Get all roles from merchant vindi
+      def list_roles(options = {})
+        get('roles', options)[:roles]
+      end
+    end
+  end
+end

data/lib/vindi/rest/subscription.rb

@@ -0,0 +1,85 @@
+module Vindi
+  module Rest
+
+    # Methods for the subscriptions API
+    # @see https://vindi.github.io/api-docs/dist/#!/subscriptions
+    module Subscription
+
+      # List subscription for the authenticate user
+      # @return [Array<Hash>] A list of subscriptions for a merchant.
+      # @example Get all subscriptions from merchant vindi
+      def list_subscriptions(options = {})
+        get('subscriptions', options)[:subscriptions]
+      end
+      
+      # Get a single subscription from a merchant
+      #
+      # @param subscription_id [Integer] ID of the subscription
+      # @return [Hash] The subscription you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/GET_version_subscriptions_id_format
+      # @example Get subscription #2 from vindi
+      #   client.subscription(2)
+      def subscription(subscription_id, options = {})
+        get("subscriptions/#{subscription_id}", options)[:subscription]
+      end
+
+      # Create a subscription for a merchant vindi
+      # 
+      # @option options [Hash] :options subscription attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/POST_version_subscriptions_format 
+      # @return [Hash] The subscription created
+      # @example Create a subscription for a merchant vindi
+      #   client.create_subscription(plan_id: 12, customer_id: 142, 
+      #                              payment_method_code: "credit_card",
+      #                              product_items: [{ product_id: 14 }])
+      def create_subscription(options = {})
+        post('subscriptions', options)[:subscription]
+      end
+
+      # Edit a subscription
+      #
+      # @params subscription_id [Integer] ID of the subscription
+      # @option options [Hash] :options subscription attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/PUT_version_subscriptions_id_format
+      # @example update subscription #2
+      #   client.update_subscription(2, payment_method_code: "debit_card")
+      def update_subscription(subscription_id, options = {})
+        put("subscriptions/#{subscription_id}", options)[:subscription]
+      end
+
+      # Renew a subscription
+      #
+      # @params subscription_id [Integer] ID of the subscription
+      # @option options [Hash] :options subscription attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/PUT_version_subscriptions_id_format
+      # @example update subscription #2
+      #   client.renew_subscription(2)
+      def renew_subscription(subscription_id, options = {})
+        post("subscriptions/#{subscription_id}/renew", options)[:subscription]
+      end
+
+      # Reactivate a subscription
+      #
+      # @params subscription_id [Integer] ID of the subscription
+      # @option options [Hash] :options subscription attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/PUT_version_subscriptions_id_format
+      # @example update subscription #2
+      #   client.reactivate_subscription(2)
+      def reactivate_subscription(subscription_id, options = {})
+        post("subscriptions/#{subscription_id}/reactivate", options)[:subscription]
+      end
+
+      # Delete a subscription from merchant vindi
+      #
+      # @params subscription_id [Integer] ID of the subscription
+      # @option options [Hash] :options subscription attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/DELETE_version_subscriptions_id_format
+      # @example Delete subscription #2
+      #   client.delete_subscription(2)
+      def delete_subscription(subscription_id, options = {})
+        delete("subscriptions/#{subscription_id}", options)[:subscription]
+      end
+    end
+  end
+end

data/lib/vindi/rest/transaction.rb

@@ -0,0 +1,53 @@
+module Vindi
+  module Rest
+
+    # Methods for the Transaction API
+    # @see https://vindi.github.io/api-docs/dist/#!/transactions
+    module Transaction
+
+      # List transactions for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of transactions for a merchant.
+      # @example Get all transactions from merchant vindi
+      def list_transactions(options = {})
+        get('transactions', options)[:transactions]
+      end
+      
+      # Get a single transaction from a merchant
+      #
+      # @param transaction_id [Integer] ID of the transaction
+      # @return [Hash] The transaction you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/transactions/GET_version_transactions_id_format
+      # @example Get transaction #2 from vindi
+      #   client.transaction(2)
+      def transaction(transaction_id, options = {})
+        get("transactions/#{transaction_id}", options)[:transaction]
+      end
+
+      # Create a transaction for a merchant vindi
+      # 
+      # @option options [Hash] :options transaction attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/transactions/POST_version_transactions_format 
+      # @return [Hash] The transaction created
+      # @example Create a transaction for a merchant vindi
+      #   client.create_transaction(charge_id: 475, amount: 100,
+      #                             payment_method_code: 'cash',
+      #                             paid_at: "2017-09-08")
+      def create_transaction(options = {})
+        post('transactions', options)[:transaction]
+      end
+
+      # Edit a transaction
+      #
+      # @params transaction_id [Integer] ID of the transaction
+      # @option options [Hash] :options transaction attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/transactions/PUT_version_transactions_id_format
+      # @example Update transaction #2
+      #   client.update_transaction(2, gateway_transaction_id: "gateway-transaction_id")
+      def update_transaction(transaction_id, options = {})
+        put("transactions/#{transaction_id}", options)[:transaction]
+      end
+    end
+  end
+end

data/lib/vindi/rest/usage.rb

@@ -0,0 +1,32 @@
+module Vindi
+  module Rest
+
+    # Methods for the Usage API
+    # @see https://vindi.github.io/api-docs/dist/#!/usages
+    module Usage
+
+      # Create a usage for a merchant vindi
+      # 
+      # @option options [Hash] :options usage attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/usages/POST_version_usages_format 
+      # @return [Hash] The usage created
+      # @example Create a usage for a merchant vindi
+      #   client.create_usage(period_id: 382, product_item_id: 141,
+      #                       quantity: 3)
+      def create_usage(options = {})
+        post('usages', options)[:usage]
+      end
+
+      # Delete a usage
+      #
+      # @params usage_id [Integer] ID of the usage
+      # @option options [Hash] :options usage attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/usages/DELETE_version_usages_id_format
+      # @example Delete usage #2
+      #   client.delete_usage(2)
+      def delete_usage(usage_id, options = {})
+        delete("usages/#{usage_id}", options)[:usage]
+      end
+    end
+  end
+end

data/lib/vindi/rest/user.rb

@@ -0,0 +1,17 @@
+module Vindi
+  module Rest
+
+    # Methods for the users API
+    # @see https://vindi.github.io/api-docs/dist/#!/users
+    module User
+
+      # List the authenticated current user
+      #
+      # @return <Hash> a current user.
+      # @example Get current user from merchant vindi
+      def current_user
+        get('users/current')[:user]
+      end
+    end
+  end
+end

data/lib/vindi/version.rb

@@ -0,0 +1,3 @@
+module Vindi
+  VERSION = '0.0.1'
+end

data/vindi.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vindi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vindi"
+  spec.version       = Vindi::VERSION
+  spec.authors       = %q{Vindi}
+  spec.email         = %q{developers@vindi.com.br}
+  spec.summary       = %q{Ruby toolkit for working with the Vindi API}
+  spec.description   = %q{Simple wrapper for the Vindi API}
+  spec.homepage      = 'https://github.com/vindi/vindi-ruby'
+  spec.files         =  %w(README.md Rakefile vindi.gemspec)
+  spec.files        +=  Dir.glob("lib/**/*.rb")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.13.1'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: vindi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vindi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Simple wrapper for the Vindi API
+email: developers@vindi.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/vindi.rb
+- lib/vindi/client.rb
+- lib/vindi/configuration.rb
+- lib/vindi/connection.rb
+- lib/vindi/default.rb
+- lib/vindi/error.rb
+- lib/vindi/request.rb
+- lib/vindi/response/raise_error.rb
+- lib/vindi/rest.rb
+- lib/vindi/rest/bill.rb
+- lib/vindi/rest/bill_item.rb
+- lib/vindi/rest/charge.rb
+- lib/vindi/rest/customer.rb
+- lib/vindi/rest/discount.rb
+- lib/vindi/rest/import_batch.rb
+- lib/vindi/rest/invoice.rb
+- lib/vindi/rest/issue.rb
+- lib/vindi/rest/merchant.rb
+- lib/vindi/rest/merchant_user.rb
+- lib/vindi/rest/message.rb
+- lib/vindi/rest/movement.rb
+- lib/vindi/rest/notification.rb
+- lib/vindi/rest/payment_method.rb
+- lib/vindi/rest/payment_profile.rb
+- lib/vindi/rest/period.rb
+- lib/vindi/rest/plan.rb
+- lib/vindi/rest/product.rb
+- lib/vindi/rest/product_item.rb
+- lib/vindi/rest/role.rb
+- lib/vindi/rest/subscription.rb
+- lib/vindi/rest/transaction.rb
+- lib/vindi/rest/usage.rb
+- lib/vindi/rest/user.rb
+- lib/vindi/version.rb
+- vindi.gemspec
+homepage: https://github.com/vindi/vindi-ruby
+licenses: []
+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: Ruby toolkit for working with the Vindi API
+test_files: []