monzo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bca691ae63f93ef6c1c6c601bd4b2e0d6f0f8c09
-  data.tar.gz: 407b2ff8fe2e498c9fe740af03a873186fc10b01
+  metadata.gz: 416017c7fb95dddb3f6abbd9b29b5113b854b912
+  data.tar.gz: ef730307125fad7edd2467933b27fe90212aa92f
 SHA512:
-  metadata.gz: be97766eedfd044f591ace66749efaafe95725eab79317282b786644b866e948e59a987aa2768a3798b3c8f475e16eb0af6dc5fa6b2d7b00cfea92bacaee5186
-  data.tar.gz: bea7bd7cf6b42d19a8c0140f64d80ba734de11354f01b8066cd15ceeff41e9ddb14713930791e2d7637f7e3f088b7b557132ca63d878b26d7281d1856534b2ba
+  metadata.gz: 274dcb2993f5ce88b9b85aad37db9668c2144e3459f73b24df1a942ff378c6c58e61d26beb44afcfac3791d9b1e1a40e9c431047d74b6054054db65ac044fe1d
+  data.tar.gz: 104e362c74e3bd84c4c8cb56daf18f22474f4110c80a7b4ebba76482b81bcfae5ec7ec41a44203f1545d0eec046107c2f75ecadf9aaf48872791f89a1522d710

data/README.md

@@ -63,6 +63,32 @@ A Pot is a place to keep some money separate from your main spending account.
 ```ruby
 # Find all Monzo Pots
 Monzo::Pot.all
+
+# Find a pot with the given pot id.
+Monzo::Pot.find(pot_id)
+
+# Move money into a pot
+account_id = Monzo::Account.all.last.id # The account to withdraw from
+pot = Monzo::Pot.all.first # Get the first pot
+pot.balance #=> eg. 5000
+
+pot.deposit!(100, account_id)
+pot.balance  #=> eg. 5100
+
+# Move money out of a pot
+account_id = Monzo::Account.all.last.id
+pot = Monzo::Pot.all.first
+pot.balance #=> eg. 5000
+
+pot.withdraw!(100, account_id)
+pot.balance  #=> eg. 4900
+```
+
+The `deposit!` and `withdrawl!` methods accept an optional `dedupe_id` parameter. It's used to prevent duplicate transactions and should remain static between retries to ensure only one deposit/withdrawl is created. If you don't provide one, a random string will be generated for each deposit/withdrawl. You should **always** provide this if there is a chance the transaction will be retried.
+
+```ruby
+dedupe_id = 'SomeniqueDeDuplicationString' # Store this and use it for retries.
+pot.deposit!(100, account_id, dedupe_id)
 ```
 
 ### Balance

data/lib/monzo.rb

@@ -1,6 +1,7 @@
 require "json"
 
 require "monzo/version"
+require "monzo/errors"
 require "monzo/account"
 require "monzo/balance"
 require "monzo/transaction"

data/lib/monzo/client.rb

@@ -65,6 +65,23 @@ module Monzo
       response = https_client(uri).request(request)
     end
 
+    # Internal: Perform a PUT request to the Monzo API.
+    #
+    # path - The URI path to request.
+    # data - The form data to send with the request.
+    # options - A Hash of query options to include in the URI.
+    #
+    # Returns a HTTP response.
+    def put(path, data, options = {})
+      uri = build_uri(path, options)
+
+      request = Net::HTTP::Put.new(uri.request_uri)
+      set_authorisation_header(request)
+      request.set_form_data(data)
+
+      response = https_client(uri).request(request)
+    end
+
     # Internal: Perform a DELETE request to the Monzo API.
     #
     # path - The URI path to request.

data/lib/monzo/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Monzo
+  # Internal: Exception to raise on reciept of API error.
+  APIError = Class.new(StandardError)
+end

data/lib/monzo/pot.rb

@@ -1,3 +1,5 @@
+require "securerandom"
+
 module Monzo
 
   # Public: Retrieve information about a pot. A Pot is a place to keep
@@ -25,13 +27,88 @@ module Monzo
     #
     # Returns An Array of Monzo::Pot
     def self.all
-      client = Monzo.client
-      response = client.get("/pots/listV1")
+      response = Monzo.client.get("/pots")
       parsed_response = JSON.parse(response.body, :symbolize_names => true)
 
       parsed_response[:pots].map do |item|
         Monzo::Pot.new(item)
       end
     end
+
+    # Public: Find a pot with the given pot id.
+    #
+    # pot_id - The id to find.
+    #
+    # Returns an instance of Monzo::Pot.
+    def self.find(pot_id)
+      response = Monzo.client.get("/pots/#{pot_id}")
+      parsed_response = JSON.parse(response.body, :symbolize_names => true)
+      Monzo::Pot.new(parsed_response)
+    end
+
+    # Public: Deposit Money in a pot
+    #
+    # amount - The amount to deposit, in pennies.
+    # source_account_id - The account_id of the account to withdraw from.
+    # dedupe_id (optional) - A random string, to prevent duplicate deposits.
+    #
+    # Returns self: a single Monzo::Pot
+    def deposit!(amount, source_account_id, dedupe_id = SecureRandom.uuid)
+      data = {
+        amount: amount,
+        source_account_id: source_account_id,
+        dedupe_id: dedupe_id,
+      }
+
+      response = Monzo.client.put("/pots/#{@id}/deposit", data)
+      parsed_response = parse_response(response)
+      update_self(parsed_response)
+    end
+
+    # Public: Withdraw Money from a pot
+    #
+    # amount - The amount to withdraw, in pennies.
+    # destination_account_id - The account_id of the account to deposit into.
+    # dedupe_id (optional) - A random string, to prevent duplicate deposits.
+    #
+    # Returns self: a single Monzo::Pot
+    def withdraw!(amount, destination_account_id, dedupe_id = SecureRandom.uuid)
+      data = {
+        amount: amount,
+        destination_account_id: destination_account_id,
+        dedupe_id: dedupe_id,
+      }
+
+      response = Monzo.client.put("/pots/#{@id}/withdraw", data)
+      parsed_response = parse_response(response)
+      update_self(parsed_response)
+    end
+
+    private
+
+    # Private: Parse the API response
+    #
+    # response - A Net::HTTPResponse provided by Monzo::Client
+    #
+    # Returns a hash representing the response or raises a Monzo::APIError
+    def parse_response(response)
+      parsed_response = JSON.parse(response.body, :symbolize_names => true)
+      if response.code.to_i.between?(400,599)
+        raise Monzo::APIError, "#{parsed_response[:code]}: #{parsed_response[:error]}"
+      end
+      parsed_response
+    end
+
+    # Private: Update the Pot instance variables
+    #
+    # parsed_response - a hash whose keys exactly match the instance variables for Monzo::Pot.
+    #
+    # Returns self (an instance of Monzo::Pot)
+    def update_self(parsed_response)
+      instance_variables.each do |iv|
+        instance_variable_set(iv, parsed_response[iv.to_s[1..-1].to_sym])
+      end
+      self
+    end
   end
 end

data/lib/monzo/version.rb

@@ -1,4 +1,4 @@
 module Monzo
   # Public: The version number of the gem.
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monzo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Murray Summers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,7 @@ files:
 - lib/monzo/balance.rb
 - lib/monzo/client.rb
 - lib/monzo/configuration.rb
+- lib/monzo/errors.rb
 - lib/monzo/feed_item.rb
 - lib/monzo/pot.rb
 - lib/monzo/transaction.rb