openbill-ruby 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e596b1c45d1e6de254938e905bbf454058bf7df
-  data.tar.gz: 9b6bfc5f5e89ac5c1479e3f3de6e4aba3ecc1619
+  metadata.gz: a75471ea494c07660f3d35539b4ea8cb609dc5cb
+  data.tar.gz: 64f789bd6587756d24d06eb07fd3953d58a82238
 SHA512:
-  metadata.gz: 2a27ab2112aed4d8f0fbf228d5570cacdb7d1ea71eee4e9927e90e07b90f0dc4e9e4deea520b0dcdaf6dd46552df1abdbb609632051023d2f3817f8890294e55
-  data.tar.gz: 023a1cf6968b662d6337aff8aa0a2b97077a01b9d31601b5b9f5d2a7324af27a4b6396a033c8130a2e92f43f6765ea256e9184cc2bc360b875eb9080cd8c318c
+  metadata.gz: 50da8cc7f4b6a391317b3e25275ee97c26f97f4fb78b68c00db17f77c77003399a83b5a661096926c667c3863697bfe02169f1f047261ca07bd31cef102a2165
+  data.tar.gz: d3ca24a7c5494219153f6ddf90c2a51043521411dbd5ed1858da8b5c5597ab934d4f9a3134577246a73f2c9b9dabdc40ce8ebe2f819b3d5104d765ec7f67606d

data/README.md

@@ -25,67 +25,78 @@ Add database configurartion to `./config/initializers/openbill.rb`
 ### Создание системных счетов
 
 ```ruby
-Openbill.config.database = 
-  ActiveRecord::Base.connection.instance_variable_get('@config');
-
+Openbill.configure do |config|
+  config.default_currency = 'RUB'
+  config.database = ActiveRecord::Base.connection.instance_variable_get('@config')
+end
 
 SystemRegistry = Openbill::Registry.new Openbill.current do |registry|
   registry.define :payments,      'Счет с которого поступает оплата'
-  registry.define :subscriptions, 'Абонентская плата'
+  registry.define :subscriptions, 'Абонентская плата с клиентских счетов'
 end
 ```
 
 Таким образом в системом реестре появляется два счета `SystemRegistry[:payments]` и `SystemRegistry[:subscriptions]`
 
-### Поддержка биллинга со стороны клиента (автоматическое создание клиентского счета):
+### Поддержка биллингово счета в клиентской модели:
 
 ```ruby
-module AccountBilling
+module OpenbillAccountSupport
   extend ActiveSupport::Concern
 
   included do
     after_commit :attach_billing, on: :create
   end
 
-  delegate :amount, to: :billing_account
-
-  def billing_account
+  def openbill_account
     Openbill.current.account([:accounts, id])
   end
 end
 ```
 
-Добавляем concern в модель ответсвенную за счет (например в User)
+Добавляем этот `concern` в модель ответсвенную за счет (например в `User`)
+
+### Операции
 
+Обычно со стороны пиложения необходимо производить несколько типовыхв операций:
 
-### Прием оплаты.
+1. Зачисление оплаты на счет клиента.
+2. Списание со счета клиента (напримре ежемесячной оплаты).
+3. Просмотр состояния счета клиента.
 
-Оплата проводится транзакцией между системным счетом `payments` и счетом клиента.
+#### 1. Зачисление оплаты на счет клиента.
+
+Оплата проводится транзакцией между системным счетом `:payments` и индивидуальным счетом клиента.
 
 ```ruby
 Openbill.current.make_transaction(
   // Счет списания
-  from_account_id: Billing.payment.id,
+  from: SystemRegistry[:payments],
 
   // Счет зачисление
-  to_account_id:   user.billing_account.id,
+  to:   user.opennill_account,
   
-  // Уникальный идентификатор транзакции
-  uri:             Openbill.current.generate_uri(:transactions, 123),
+  // Уникальный идентификатор транзакции. Идентификтор должен содержать
+  // ключи исключающие случайное повторное проведение данной транзакции.
+  // Обычно сюда включают номер транзакции из платежного шлюза
+  key:             'N123132131',
 
   // Сумма транзакции. Валюта должна совпадать с обоими счетами
-  amount:          Money(123, 'RUB'),
+  amount:          Money.new(123, 'RUB'),
 
-  // Не обязательное текстовое описание транзакции
+  // Не обязательное текстовое описание транзакции. Например детали из платежного шлюза.
   details:         'Оплата такая-то',
 
-  // hash с данными транзакции для структурированного поиска в дальнейшем
-  meta:            { key: 'value' } // не обязательно
+  // Необязательнай hash с данными транзакции для структурированного поиска в дальнейшем
+  meta:            { gateway: :cloudpayments }
 )
 ```
 
 ## Development
 
+
+> bundle exec rake db:migrate:down VERSION=20160320150928
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).

data/lib/openbill/registry.rb

@@ -3,6 +3,8 @@ module Openbill
     SYSTEM_NS = :system
     AccountNotFound = Class.new StandardError
 
+    attr_reader :accounts
+
     def initialize(service, system_ns = SYSTEM_NS)
       fail("Must be a Openbill::Service #{service}") unless service.is_a? Openbill::Service
       @service = service
@@ -10,19 +12,16 @@ module Openbill
       @accounts = {}
       yield self
       @accounts.freeze
-      return @accounts
-    rescue
-      @system_ns = nil
     end
 
     # Находит, или создает аккаунт с указанным именем
     #
-    def define(name, options)
-      @accounts[name] = service.account([system_ns, name], options)
+    def define(name, details)
+      accounts[name] = service.account([system_ns, name], details: details)
     end
 
     def [](name)
-      @account[name]
+      accounts[name]
     end
 
     def find(name)

data/lib/openbill/service.rb

@@ -22,9 +22,22 @@ module Openbill
     #
     # @param options - опции применяемые для создания аккаунта (см create_account)
     #
-    def account(uri, options = {})
+    def account(uri, currency: nil, details: nil, meta: {})
       uri = prepare_uri uri
-      get_account_by_uri(uri) || create_account(uri, options)
+      account = get_account_by_uri(uri)
+      currency ||= config.default_currency
+
+      if account.present?
+        fail "Account currency is wrong #{account.amount_currency} <> #{currency}" unless account.amount_currency == currency
+        # TODO update details and meta
+        return account
+      end
+
+      create_account(uri, currency: currency, details: details, meta: meta)
+    end
+
+    def get_account_by_id(id)
+      Openbill::Account[id: id]
     end
 
     def get_account_by_uri(uri)
@@ -43,13 +56,16 @@ module Openbill
     end
 
     # @param uri - уникальный uri транзакции
-    def make_transaction(from_account_id:, to_account_id:, amount:, uri:, details: nil, meta: {})
-      amount = prepare_amount amoount
+    def make_transaction(from:, to:, amount:, uri:, details: , meta: {})
+      account_from = get_account_id from
+      account_to = get_account_id to
+
+      amount = prepare_amount amount, account_from.amount_currency
       uri = prepare_uri uri
 
       Openbill::Transaction.create(
-        from_account_id: from_account_id,
-        to_account_id:   to_account_id,
+        from_account_id: account_from.id,
+        to_account_id:   account_to.id,
         amount_cents:    amount.cents,
         amount_currency: amount.currency,
         uri:             uri,
@@ -64,10 +80,30 @@ module Openbill
 
     delegate :logger, to: Rails
 
-    def prepare_amount(amount)
-      return amount if amount.is_a? Money
-      return Money.new(amount, config.default_currency) if amount.is_a? Fixnum
-      raise "amount parameter (#{amount}) must be a Money or a Fixnum"
+    def get_account_id(account)
+      case account
+      when Fixnum
+        get_account_by_uri(account)
+      when String, Array
+        get_account_by_uri(account)
+      when Openbill::Account
+        account
+      else
+        fail "Unknown type of account #{account}. Must be Fixnum, String, Array or Openbill::Account"
+      end
+    end
+
+    def prepare_amount(amount, account_currency)
+      if amount.is_a? Money
+        unless amount.currency == account_currency
+          fail "Amount currency is wrong #{amount.currency}<>#{account_currency}"
+        end
+        return amount
+      end
+
+      raise "amount parameter (#{amount}) must be a Money or a Fixnum" unless amount.is_a? Fixnum
+
+      Money.new(amount, account_currency)
     end
 
     def prepare_uri(uri)

data/lib/openbill/version.rb

@@ -1,3 +1,3 @@
 module Openbill
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/sql/1_trigger_disable_delete_account.sql

@@ -7,14 +7,15 @@ BEGIN
   IF current_query() like 'insert into OPENBILL_TRANSACTIONS%' THEN
     RETURN NEW;
   ELSE
-    RAISE EXCEPTION 'Cannot update directly update amount_cents and timestamps of account';
+    RAISE EXCEPTION 'Cannot directly update amount_cents and timestamps of account with query (#%)', current_query();
   END IF;
 END
 
 $disable_update_account$ LANGUAGE plpgsql;
 
-CREATE TRIGGER disable_update_account
-  BEFORE UPDATE ON OPENBILL_ACCOUNTS FOR EACH ROW EXECUTE PROCEDURE disable_update_account();
+-- временно отключаем, так как она не правильно срабатывает на операциях типа INSERT INTO "openbill_transactions"
+-- CREATE TRIGGER disable_update_account
+  -- BEFORE UPDATE ON OPENBILL_ACCOUNTS FOR EACH ROW EXECUTE PROCEDURE disable_update_account();
 
 CREATE OR REPLACE FUNCTION disable_delete_account() RETURNS TRIGGER AS $disable_delete_account$
 BEGIN

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openbill-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Danil Pismenny