darujme_cz 0.1.1

data/README.md

@@ -0,0 +1,62 @@
+# DarujmeCz
+[![Build Status](https://travis-ci.org/luk4s/darujme_cz.svg?branch=master)](https://travis-ci.org/luk4s/darujme_cz)
+[![Maintainability](https://api.codeclimate.com/v1/badges/568759e4ec0a2e1960b2/maintainability)](https://codeclimate.com/github/luk4s/darujme_cz/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/568759e4ec0a2e1960b2/test_coverage)](https://codeclimate.com/github/luk4s/darujme_cz/test_coverage)
+
+Darujme API https://www.darujme.cz/doc/api/v1/index.html.
+
+This is a ruby library for access Darujme API. Get pledges for your organization, check transactions or donors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'darujme_cz'
+```
+## Configuration
+
+Firstly you need obtain `apiId` and `apiSecret` for your organization.
+
+Then configure gem with `orgnazionation_id`, `api_id` and `api_secret`.
+
+In your application create `config/initializers/darujme_cz.rb`
+
+```ruby
+DarujmeCz.configure do |config|
+  config.organization_id = 434
+  config.app_id = "1234"
+  config.app_secret = "6b6fd1568d89c"
+end
+```
+
+## Usage
+
+```ruby
+pledges = DarujmeCz::Pledge.where fromOutgoingDate: Date.yesterday
+donor = pledges[0].donor # => DarujmeCz::Donor
+donor.name # => "Jan Novák"
+last_transaction = pledges[0].transactions.last # => DarujmeCz::Transaction
+last_transaction.received_at # => 2019-05-06 00:00:00 +0200
+last_transaction.outgoing_amount # => #<Money fractional:39200 currency:CZK>
+```
+
+## 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]/darujme_cz. 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
+
+GNU General Public License v3.0
+
+See [COPYING](./COPYING) to see the full text.
+
+## Code of Conduct
+
+Everyone interacting in the DarujmeCz project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/darujme_cz/blob/master/CODE_OF_CONDUCT.md).

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 "darujme_cz"
+
+# 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/darujme_cz.gemspec

@@ -0,0 +1,47 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "darujme_cz/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "darujme_cz"
+  spec.version = DarujmeCz::VERSION
+  spec.authors = ["Lukáš Pokorný"]
+  spec.email = ["luk4s.pokorny@gmail.com"]
+
+  spec.summary = 'Ruby library for work with Darujme.cz API'
+  spec.description = 'Get pledges or transactions from your organization on Darujme.cz'
+  spec.homepage = "https://github.com/luk4s/darujme_cz"
+  spec.license = "GPL-3.0-or-later"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/luk4s/darujme_cz"
+    spec.metadata["changelog_uri"] = "https://github.com/luk4s/darujme_cz/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.test_files = Dir['spec/**/*']
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '> 5.2'
+  spec.add_dependency 'money', '~> 6.13'
+  spec.add_dependency 'rest-client', '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency('webmock', '~> 3.4')
+end

data/lib/darujme_cz/address.rb

@@ -0,0 +1,20 @@
+module DarujmeCz
+  class Address
+
+    # @param [Hash] attributes
+    def initialize(attributes)
+      @source = attributes
+    end
+
+    def to_s
+      "#{@source["street"]}\n#{@source["postCode"]} #{@source["city"]}\n#{@source["country"]}"
+    end
+
+    %w[street postCode city country].each do |m|
+      define_method m.underscore do
+        @source[m]
+      end
+    end
+
+  end
+end

data/lib/darujme_cz/base.rb

@@ -0,0 +1,32 @@
+module DarujmeCz
+  class Base
+
+    # @abstract Define name of endpoint, which is also name of root element
+    def self.endpoint
+      raise NotImplementedError
+    end
+
+    # @param [Hash] params
+    # @option params [Integer] organization_id (nil) ID of organization
+    def self.all(**params)
+      where params
+    end
+
+    def self.where(**params)
+      c = Connection.new DarujmeCz.config.app_id, DarujmeCz.config.app_secret
+      org = params.delete(:organization_id) || DarujmeCz.config.organization_id
+      raise ArgumentError, "Missing organization ID" if org.nil?
+
+      data = c.get "organization/#{org}/#{endpoint}-by-filter", params
+      data[endpoint].map { |i| new(i) }
+    end
+
+    attr_reader :id
+
+    # @param [Hash] attributes
+    def initialize(attributes)
+      @source = attributes
+    end
+
+  end
+end

data/lib/darujme_cz/connection.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'rest-client'
+require 'uri'
+
+module DarujmeCz
+  class Connection
+
+    URL = "https://www.darujme.cz/api/v1"
+
+    # @param [String] app_id
+    # @param [String] api_key
+    def initialize(app_id, api_key)
+      @app_id = app_id
+      @api_key = api_key
+    end
+
+    # @param [String] path
+    # @param [Hash] params
+    def get(path, **params)
+      begin
+        response = RestClient.get "#{URL}/#{path}", params: { apiId: @app_id, apiSecret: @api_key }.merge(params)
+      rescue RestClient::Exception => ex
+        handle_response_error(ex)
+      end
+      parse_response(response)
+    end
+
+    def post(path, **data)
+      # @todo
+      raise NotImplementedError
+    end
+
+    private
+
+    # @param [RestClient::Exception] exception
+    # @raise [RestClient::Exception]
+    def handle_response_error(exception)
+      data = parse_response(exception.response)
+      exception.message += "\n#{data["message"]}"
+      raise exception
+    end
+
+    def parse_response(response)
+      JSON.parse(response.body)
+    rescue JSON::ParserError => _ex
+      {}
+    end
+
+  end
+end

data/lib/darujme_cz/donor.rb

@@ -0,0 +1,25 @@
+module DarujmeCz
+  class Donor
+
+    delegate :city, :street, :postal_code, :country, to: :address
+    # @param [Hash] attributes
+    def initialize(attributes)
+      @source = attributes
+    end
+
+    def name
+      "#{first_name} #{last_name}"
+    end
+
+    def address
+      @address = Address.new(@source["address"]) if @source["address"]
+    end
+
+    %w[firstName lastName email phone].each do |m|
+      define_method m.underscore do
+        @source[m]
+      end
+    end
+
+  end
+end

data/lib/darujme_cz/pledge.rb

@@ -0,0 +1,50 @@
+module DarujmeCz
+  # @see https://www.darujme.cz/doc/api/v1/index.html#endpoint-get-organization-organizationid-pledges-by-filter
+  class Pledge < Base
+
+    def self.endpoint
+      "pledges"
+    end
+
+    # @param [Hash] attributes
+    def initialize(attributes)
+      @id = attributes["pledgeId"]
+      super
+    end
+
+    def recurrent?
+      !!@source["isRecurrent"]
+    end
+
+    def want_donation_certificate?
+      !!@source["wantDonationCertificate"]
+    end
+
+    # @return [Money]
+    def amount
+      @amount ||= ::Money.new(*@source["pledgedAmount"].values)
+    end
+
+    # @return [Time]
+    def pledged_at
+      @source["pledgedAt"].to_time
+    end
+
+    %w[organizationId projectId promotionId paymentMethod].each do |m|
+      define_method m.underscore do
+        @source[m]
+      end
+    end
+
+    def donor
+      @donor ||= Donor.new @source["donor"]
+    end
+
+    def transactions
+      @transactions ||= Array(@source["transactions"]).collect do |transaction_source|
+        Transaction.new(transaction_source)
+      end
+    end
+
+  end
+end

data/lib/darujme_cz/transaction.rb

@@ -0,0 +1,37 @@
+module DarujmeCz
+  # @see https://www.darujme.cz/doc/api/v1/index.html#endpoint-get-organization-organizationid-transactions-by-filter
+  class Transaction < Base
+
+    def self.endpoint
+      "transactions"
+    end
+
+    # @param [Hash] attributes
+    def initialize(attributes)
+      @id = attributes["transactionId"]
+      super
+    end
+
+    def sent_amount
+      @sent_amount ||= ::Money.new(*@source["sentAmount"].values)
+    end
+
+    def outgoing_amount
+      @outgoing_amount ||= ::Money.new(*@source["outgoingAmount"].values)
+    end
+
+    def received_at
+      @source["receivedAt"].to_time
+    end
+
+    def pledge
+      @pledge ||= Pledge.new(@source["pledge"])
+    end
+
+    %w[outgoingVs outgoingBankAccount].each do |m|
+      define_method m.underscore do
+        @source[m]
+      end
+    end
+  end
+end

data/lib/darujme_cz/version.rb

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

data/lib/darujme_cz.rb

@@ -0,0 +1,19 @@
+require "darujme_cz/version"
+require "active_support/core_ext/string"
+require "active_support/configurable"
+require "money"
+require "ostruct"
+
+module DarujmeCz
+  class Error < StandardError; end
+  # Your code goes here...
+  autoload :Address, "darujme_cz/address"
+  autoload :Base, "darujme_cz/base"
+  autoload :Connection, "darujme_cz/connection"
+  autoload :Donor, "darujme_cz/donor"
+  autoload :Pledge, "darujme_cz/pledge"
+  autoload :Transaction, "darujme_cz/transaction"
+
+  include ActiveSupport::Configurable
+  config_accessor :app_id, :app_secret, :organization_id
+end

data/spec/darujme_cz_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe DarujmeCz do
+  it "has a version number" do
+    expect(DarujmeCz::VERSION).not_to be nil
+  end
+end

data/spec/fixtures/files/donor.json

@@ -0,0 +1,12 @@
+{
+  "firstName": "Jan",
+  "lastName": "Novák",
+  "email": "jan.novak@seznam.cz",
+  "address": {
+    "street": "Otakarova 34",
+    "city": "Praha",
+    "postCode": "120 00",
+    "country": "ČR"
+  },
+  "phone": "+420 123 456 789"
+}

data/spec/fixtures/files/pledges.json

@@ -0,0 +1,48 @@
+{
+  "pledges": [
+    {
+      "pledgeId": 1203450,
+      "organizationId": 2,
+      "projectId": 4563,
+      "promotionId": null,
+      "paymentMethod": "gp_webpay_charge",
+      "isRecurrent": true,
+      "pledgedAmount": {
+        "cents": 135800,
+        "currency": "CZK"
+      },
+      "pledgedAt": "2019-04-07T15:30:57+02:00",
+      "donor": {
+        "firstName": "Jan",
+        "lastName": "Novák",
+        "email": "jan.novak@seznam.cz",
+        "address": {
+          "street": "Otakarova 34",
+          "city": "Praha",
+          "postCode": "120 00",
+          "country": "ČR"
+        },
+        "phone": "+420 123 456 789"
+      },
+      "wantDonationCertificate": true,
+      "customFields": {},
+      "transactions": [
+        {
+          "transactionId": 1544,
+          "state": "success",
+          "sentAmount": {
+            "cents": 135800,
+            "currency": "CZK"
+          },
+          "receivedAt": "2019-04-08T00:00:00+02:00",
+          "outgoingAmount": {
+            "cents": 133084,
+            "currency": "CZK"
+          },
+          "outgoingVs": null,
+          "outgoingBankAccount": "01234/0100"
+        }
+      ]
+    }
+  ]
+}

data/spec/fixtures/files/transactions.json

@@ -0,0 +1,46 @@
+{
+  "transactions": [
+    {
+      "transactionId": 3,
+      "state": "refund",
+      "sentAmount": {
+        "cents": 124500,
+        "currency": "CZK"
+      },
+      "receivedAt": "2019-04-07T15:30:57+02:00",
+      "outgoingAmount": {
+        "cents": 124500,
+        "currency": "CZK"
+      },
+      "outgoingVs": "6432997",
+      "outgoingBankAccount": "12345/0100",
+      "pledge": {
+        "pledgeId": 1203450,
+        "organizationId": 2,
+        "projectId": 4563,
+        "promotionId": null,
+        "paymentMethod": "gp_webpay_charge",
+        "isRecurrent": true,
+        "pledgedAmount": {
+          "cents": 678200,
+          "currency": "CZK"
+        },
+        "pledgedAt": "2019-04-07T15:30:57+02:00",
+        "donor": {
+          "firstName": "Jan",
+          "lastName": "Novák",
+          "email": "jan.novak@seznam.cz",
+          "address": {
+            "street": "Otakarova 34",
+            "city": "Praha",
+            "postCode": "120 00",
+            "country": "ČR"
+          },
+          "phone": "+420 123 456 789"
+        },
+        "wantDonationCertificate": true,
+        "customFields": {}
+      }
+    }
+  ]
+}

data/spec/models/connect_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe DarujmeCz::Connection do
+  subject { described_class.new "22", "8d948b1" }
+
+  describe ".get" do
+    it "get all" do
+      stub_request(:get, "https://www.darujme.cz/api/v1/organization/22/pledges-by-filter?apiId=22&apiSecret=8d948b1").
+        to_return(status: 200, body: file_fixture("pledges.json"))
+      data = subject.get "organization/22/pledges-by-filter"
+      expect(data).to include "pledges"
+    end
+  end
+
+end

data/spec/models/donor_spec.rb

@@ -0,0 +1,29 @@
+RSpec.describe DarujmeCz::Donor do
+  let(:attributes) { JSON.parse(file_fixture("donor.json").read) }
+
+  subject { described_class.new attributes }
+
+  it "#attributes" do
+    expect(subject).to have_attributes first_name: "Jan", last_name: "Novák"
+  end
+
+  it "#name" do
+    expect(subject.name).to eq "Jan Novák"
+  end
+
+  describe "#address" do
+    it { expect(subject.address).to be_a DarujmeCz::Address }
+    it "text address" do
+      expect(subject.address.to_s).to eq "Otakarova 34\n120 00 Praha\nČR"
+    end
+
+    it "#city" do
+      expect(subject.address.city).to eq "Praha"
+    end
+  end
+
+  it "#street" do
+    expect(subject.street).to eq "Otakarova 34"
+  end
+
+end

data/spec/models/pledge_spec.rb

@@ -0,0 +1,85 @@
+require "rest-client"
+RSpec.describe DarujmeCz::Pledge do
+  describe ".all" do
+    it "get all" do
+      stub_request(:get, "https://www.darujme.cz/api/v1/organization/#{DarujmeCz.config.organization_id}/pledges-by-filter?apiId=#{DarujmeCz.config.app_id}&apiSecret=#{DarujmeCz.config.app_secret}").
+        to_return(status: 200, body: file_fixture("pledges.json"))
+
+      pledges = described_class.all
+      expect(pledges).to be_a Array
+      expect(pledges[0]).to have_attributes "organization_id" => 2
+    end
+
+    it "without organization_id" do
+      DarujmeCz.config.organization_id = nil
+      expect { described_class.all }.to raise_exception ArgumentError
+    end
+
+    it "without credentials" do
+      DarujmeCz.config.app_id = nil
+
+      stub_request(:get, "https://www.darujme.cz/api/v1/organization/#{DarujmeCz.config.organization_id}/pledges-by-filter?apiId&apiSecret=#{DarujmeCz.config.app_secret}").
+        to_return(status: 400, body: darujme_cz_response_error(message: "Missing required parameter").to_json)
+
+      expect { described_class.all }.to raise_exception RestClient::BadRequest, "400 Bad Request\nMissing required parameter"
+    end
+
+    it "pass custom organization_id" do
+      stub = stub_request(:get, "https://www.darujme.cz/api/v1/organization/33/pledges-by-filter?apiId=#{DarujmeCz.config.app_id}&apiSecret=#{DarujmeCz.config.app_secret}").
+        to_return(status: 200, body: file_fixture("pledges.json"))
+
+      described_class.all(organization_id: 33)
+      expect(stub).to have_been_made
+    end
+  end
+
+  describe ".where" do
+    it "fromOutgoingDate" do
+      stub = stub_request(:get, "https://www.darujme.cz/api/v1/organization/#{DarujmeCz.config.organization_id}/pledges-by-filter?apiId=#{DarujmeCz.config.app_id}&apiSecret=#{DarujmeCz.config.app_secret}&fromOutgoingDate=#{Date.today.strftime("%Y-%m-%d")}").
+        to_return(status: 200, body: file_fixture("pledges.json"))
+      described_class.where fromOutgoingDate: Date.today
+
+      expect(stub).to have_been_made
+    end
+  end
+
+  let(:json) { JSON.parse file_fixture("pledges.json").read }
+  subject { described_class.new json["pledges"][0] }
+
+  describe "attributes" do
+
+    it "inspect" do
+      expect(subject.project_id).to eq 4563
+      expect(subject.id).to eq 1203450
+    end
+  end
+
+  describe "#amount" do
+    it { expect(subject.amount.to_f).to eq 1358.0 }
+    it { expect(subject.amount.currency).to eq "CZK" }
+  end
+
+  describe "#pledged_at" do
+    it { expect(subject.pledged_at).to be_a Time }
+  end
+
+  describe "#recurrent?" do
+    it { expect(subject.recurrent?).to eq true }
+  end
+
+  describe "#want_donation_certificate?" do
+    it { expect(subject.want_donation_certificate?).to eq true }
+  end
+
+  describe "#donor" do
+    it { expect(subject.donor).to be_a DarujmeCz::Donor }
+  end
+
+  describe "#transactions" do
+    it "be a array" do
+      expect(subject.transactions).to be_a Array
+      expect(subject.transactions[0]).to be_a DarujmeCz::Transaction
+    end
+  end
+
+end

data/spec/models/transaction_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe DarujmeCz::Transaction do
+  describe ".all" do
+    it "get all" do
+      stub_request(:get, "https://www.darujme.cz/api/v1/organization/#{DarujmeCz.config.organization_id}/transactions-by-filter?apiId=#{DarujmeCz.config.app_id}&apiSecret=#{DarujmeCz.config.app_secret}").
+        to_return(status: 200, body: file_fixture("transactions.json"))
+
+      pledges = described_class.all
+      expect(pledges).to be_a Array
+      expect(pledges[0]).to have_attributes "outgoing_bank_account" => "12345/0100"
+    end
+  end
+
+  let(:json) { JSON.parse file_fixture("transactions.json").read }
+  subject { described_class.new json["transactions"][0] }
+
+  it "#pledge" do
+    expect(subject.pledge).to be_a DarujmeCz::Pledge
+  end
+
+  it "#sent_amount" do
+    expect(subject.sent_amount).to be_a Money
+  end
+
+  it "#outgoing_amount" do
+    expect(subject.outgoing_amount).to be_a Money
+  end
+
+  it "#received_at" do
+    expect(subject.received_at).to be_a Time
+  end
+
+end