starlingrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d93eea4aead2fbfebd8fc5ae0e01f0d49620476f796328387f8086297cddcd8f
+  data.tar.gz: 786317b144325616e05276784dbbf1a7690c2b53e784972d7d6b5ebdfebef41b
+SHA512:
+  metadata.gz: 01d2dd018610e64f9758205c74da9a8053bd69549c39ee4f52930a96c51a6db8c8e99a7962e914009e602158ca0ce961a61edf0095ad929d7925799d2a4c2cf2
+  data.tar.gz: 0dd89eac0ea660bf1a599097123ca73c6eb80b424bc14ffc07224984bbe8e2b749acd1580f2d0a1fa44c7d1657669801f37746333d032c4187afe79b4140c26a

data/.env.example

@@ -0,0 +1 @@
+STARLING_ACCESS_TOKEN=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in starling.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    starlingrb (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  rake (~> 13.0)
+  starlingrb!
+
+BUNDLED WITH
+   2.2.30

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dean Perry
+
+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,45 @@
+# StarlingRB
+
+**This library is a work in progress**
+
+StarlingRB is a Ruby library for interacting with the Starling Bank API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "starlingrb", require: "starling"
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly you'll need to set an Access Token.
+
+```ruby
+@client = Starling::Client.new(access_token: "")
+```
+
+### Accounts
+
+```ruby
+Starling::Account.list
+Starling::Account.balance(account: "account_uid")
+```
+
+### Transactions
+
+```ruby
+# from and to should be date time stamps
+Starling::Transaction.list(account: "account_uid", from: Date.parse("2023-01-01").to_datetime, to: Date.today.to_datetime)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/starlingrb.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "starling"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# 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
+
+Starling.configure do |config|
+  config.environment = :sandbox
+  config.access_token = ENV["STARLING_ACCESS_TOKEN"]
+end
+
+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/starling/client.rb

@@ -0,0 +1,72 @@
+module Starling
+  class Client
+
+    BASE_PRODUCTION_URL = "https://api.starlingbank.com/api/v2"
+    BASE_SANDBOX_URL = "https://api-sandbox.starlingbank.com/api/v2"
+
+    class << self
+
+      def connection
+        @connection ||= Faraday.new(Starling.config.url) do |conn|
+          conn.request :authorization, :Bearer, Starling.config.access_token
+          conn.request :json
+
+          conn.headers = {
+            "User-Agent" => "starlingrb/v#{VERSION} (github.com/deanpcmad/starlingrb)"
+          }
+
+          conn.response :dates
+          conn.response :json, content_type: "application/json"
+        end
+      end
+
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(url, params, headers)
+      end
+
+      def post_request(url, body: {}, headers: {})
+        handle_response connection.post(url, body, headers)
+      end
+
+      def put_request(url, body:, headers: {})
+        handle_response connection.put(url, body, headers)
+      end
+
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(url, body, headers)
+      end
+
+      def delete_request(url, headers: {})
+        handle_response connection.delete(url, headers)
+      end
+
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed. '#{response.body["error_description"]}'"
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error_description"]}'"
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error_description"]}'"
+        when 404
+          raise Error, "Error 404: No results were found for your request."
+        when 409
+          raise Error, "Error 409: Your request was a conflict. '#{response.body["error_description"]}'"
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error_description"]}'"
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error_description"]}'"
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error_description"]}'"
+        when 501
+          raise Error, "Error 501: This resource has not been implemented. '#{response.body["error_description"]}'"
+        when 204
+          return true
+        end
+
+        response
+      end
+
+    end
+  end
+end

data/lib/starling/collection.rb

@@ -0,0 +1,19 @@
+module Starling
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, key:)
+      body = response.body
+
+      new(
+        data: body[key].map { |attrs| type.new(attrs) },
+        total: body[key].count
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/starling/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Starling
+  class Configuration
+
+    attr_accessor :environment, :access_token
+
+    def url
+      if environment == :sandbox
+        Starling::Client::BASE_SANDBOX_URL
+      elsif environment == :production
+        Starling::Client::BASE_PRODUCTION_URL
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/starling/error.rb

@@ -0,0 +1,4 @@
+module Starling
+  class Error < StandardError
+  end
+end

data/lib/starling/models/account.rb

@@ -0,0 +1,18 @@
+module Starling
+  class Account < Object
+
+    class << self
+
+      def list
+        response = Client.get_request("accounts")
+        Collection.from_response(response, type: Account, key: "accounts")
+      end
+
+      def balance(account:)
+        Balance.new Client.get_request("accounts/#{account}/balance").body
+      end
+
+    end
+
+  end
+end

data/lib/starling/models/account_holders.rb

@@ -0,0 +1,13 @@
+module Starling
+  class AccountHoldersResource < Resource
+
+    def account_holder
+      AccountHolder.new get_request("account-holder").body
+    end
+
+    def name
+      AccountHolder.new get_request("account-holder/name").body
+    end
+    
+  end
+end

data/lib/starling/models/balance.rb

@@ -0,0 +1,4 @@
+module Starling
+  class Balance < Object
+  end
+end

data/lib/starling/models/card.rb

@@ -0,0 +1,76 @@
+module Starling
+  class Card < Object
+
+    class << self
+      def list
+        response = Client.get_request("cards")
+        Collection.from_response(response, type: Card, key: "cards")
+      end
+
+      # Enables or Disables a card
+      # Required scope: card-control:edit
+      def enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Enables or Disables ATM Withdrawal
+      # Required scope: card-control:edit
+      def atm_enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/atm-enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Enables or Disables Gambling
+      # Required scope: card-control:edit
+      def gambling_enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/gambling-enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Enables or Disables Mag Stripe
+      # Required scope: card-control:edit
+      def mag_stripe_enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/mag-stripe-enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Enables or Disables Mobile Wallet
+      # Required scope: card-control:edit
+      def mobile_wallet_enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/mobile-wallet-enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Enables or Disables Online
+      # Required scope: card-control:edit
+      def online_enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/online-enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Enables or Disables POS (contactless & chip and pin)
+      # Required scope: card-control:edit
+      def pos_enabled(uid:, enabled:)
+        response = Client.put_request("cards/#{uid}/controls/pos-enabled", body: {enabled: enabled})
+
+        return true if response.success?
+      end
+
+      # Required scope: card-control:edit
+      def currency_switch(uid:, enabled:, currency:)
+        body = {enabled: enabled, currency: currency}
+        response = Client.put_request("cards/#{uid}/controls/currency-switch", body: body)
+
+        return true if response.success?
+      end
+    end
+
+  end
+end

data/lib/starling/models/direct_debit_mandates.rb

@@ -0,0 +1,27 @@
+module Starling
+  class DirectDebitMandatesResource < Resource
+
+    # Required scope: mandate:read
+    def list
+      response = get_request("direct-debit/mandates")
+      Collection.from_response(response, type: DirectDebitMandate, key: "mandates")
+    end
+
+    # Required scope: mandate:read
+    def retrieve(uid:)
+      DirectDebitMandate.new get_request("direct-debit/mandates/#{uid}").body
+    end
+
+    # Required scope: mandate:read
+    def payments(uid:, since:)
+      response = get_request("direct-debit/mandates/#{uid}/payments", params: {since: since})
+      Collection.from_response(response, type: DirectDebitPayment, key: "directDebitPayments")
+    end
+
+    # Required scope: mandate:delete
+    def cancel(uid:)
+      delete_request("direct-debit/mandates/#{uid}")
+    end
+
+  end
+end

data/lib/starling/models/transaction.rb

@@ -0,0 +1,15 @@
+module Starling
+  class Transaction < Object
+
+    class << self
+
+      def list(account:, from:, to:)
+        params = {minTransactionTimestamp: from, maxTransactionTimestamp: to}
+        response = Client.get_request("feed/account/#{account}/settled-transactions-between", params: params)
+        Collection.from_response(response, type: Transaction, key: "feedItems")
+      end
+
+    end
+
+  end
+end

data/lib/starling/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Starling
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/starling/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Starling
+  VERSION = "0.1.0"
+end

data/lib/starling.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+require_relative "starling/version"
+
+module Starling
+
+  autoload :Configuration, "starling/configuration"
+  autoload :Client, "starling/client"
+  autoload :Collection, "starling/collection"
+  autoload :Error, "starling/error"
+  autoload :Object, "starling/object"
+
+  class << self
+    attr_writer :config
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.config
+    @config ||= Starling::Configuration.new
+  end
+
+  autoload :Account, "starling/models/account"
+  autoload :Card, "starling/models/card"
+  autoload :Transaction, "starling/models/transaction"
+
+  # Additional
+  autoload :Balance, "starling/models/balance"
+
+end

data/starlingrb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/starling/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "starlingrb"
+  spec.version       = Starling::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+
+  spec.summary       = "A Ruby library for interacting with the Starling Bank API"
+  spec.homepage      = "https://deanpcmad.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/starlingrb"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: starlingrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description:
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/starling.rb
+- lib/starling/client.rb
+- lib/starling/collection.rb
+- lib/starling/configuration.rb
+- lib/starling/error.rb
+- lib/starling/models/account.rb
+- lib/starling/models/account_holders.rb
+- lib/starling/models/balance.rb
+- lib/starling/models/card.rb
+- lib/starling/models/direct_debit_mandates.rb
+- lib/starling/models/transaction.rb
+- lib/starling/object.rb
+- lib/starling/version.rb
+- starlingrb.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/starlingrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A Ruby library for interacting with the Starling Bank API
+test_files: []