starling-ruby 0.1.0 → 0.2.0

data/lib/starling/services/transactions_service.rb

@@ -0,0 +1,44 @@
+module Starling
+  module Services
+    # A service for accessing the Transactions API
+    class TransactionsService < BaseService
+      # @param id [String] The Starling internal ID of the transaction
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Resources::TransactionResource]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def get(id, params: {}, headers: {})
+        response = api_service.make_request(:get,
+                                            "/transactions/#{id}",
+                                            params: params,
+                                            headers: headers)
+        resource.new(response: response)
+      end
+
+      # @param params [Hash] Parameters which will be included in the HTTP request,
+      #                      included in the URL as a query string
+      # @param headers [Hash] Headers which be included in the HTTP request, merged on
+      #                       top of the headers set at the {Client} level
+      # @return [Array<Resources::TransactionResource>]
+      # @raise [Errors::ApiError] if the HTTP request returns a status indicating that it
+      #                           was unsuccessful
+      def list(params: {}, headers: {})
+        response = api_service.make_request(:get, '/transactions', params: params,
+                                                                   headers: headers)
+
+        build_collection_from_embedded_key(response,
+                                           key: 'transactions',
+                                           resource: resource)
+      end
+
+      private
+
+      def resource
+        Resources::TransactionResource
+      end
+    end
+  end
+end

data/lib/starling/utils.rb

@@ -0,0 +1,30 @@
+module Starling
+  # A collection of utility methods used across starling-ruby
+  class Utils
+    class << self
+      # @return [String] The gem's name and version
+      def gem_info
+        return 'starling-ruby' unless defined?(Starling::VERSION)
+        "starling-ruby/v#{Starling::VERSION}"
+      end
+
+      # @return [String] The Ruby engine this code is currently running on
+      def ruby_engine
+        defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
+      end
+
+      # @return [String] The Ruby version and patchlevel this code is currently running
+      #                  on
+      def ruby_version
+        return RUBY_VERSION unless defined?(RUBY_PATCHLEVEL)
+        RUBY_VERSION + "p#{RUBY_PATCHLEVEL}"
+      end
+
+      # @return [String] The JRuby interpreter version this code is currently running on,
+      #                  or the Ruby version for non-JRuby environments
+      def interpreter_version
+        defined?(JRUBY_VERSION) ? JRUBY_VERSION : RUBY_VERSION
+      end
+    end
+  end
+end

data/lib/starling/version.rb

@@ -1,3 +1,3 @@
 module Starling
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/starling-ruby.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.10.4'
   spec.add_development_dependency 'values', '~> 1.8.0'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2.3'
+  spec.add_development_dependency 'yard', '~> 0.8.7.6'
+  spec.add_development_dependency 'reek', '~> 4.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starling-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -156,6 +156,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
 description: 
 email:
 - tim@gocardless.com
@@ -165,6 +193,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gitignore"
+- ".reek"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -185,10 +214,42 @@ files:
 - lib/starling/request.rb
 - lib/starling/resources/account_balance_resource.rb
 - lib/starling/resources/account_resource.rb
+- lib/starling/resources/address_resource.rb
+- lib/starling/resources/addresses_resource.rb
 - lib/starling/resources/base_resource.rb
+- lib/starling/resources/card_resource.rb
+- lib/starling/resources/contact_account_resource.rb
+- lib/starling/resources/contact_resource.rb
+- lib/starling/resources/customer_resource.rb
+- lib/starling/resources/direct_debit_mandate_resource.rb
+- lib/starling/resources/direct_debit_transaction_resource.rb
+- lib/starling/resources/inbound_faster_payments_transaction_resource.rb
+- lib/starling/resources/mastercard_transaction_resource.rb
+- lib/starling/resources/me_resource.rb
+- lib/starling/resources/merchant_location_resource.rb
+- lib/starling/resources/merchant_resource.rb
+- lib/starling/resources/outbound_faster_payments_transaction_resource.rb
+- lib/starling/resources/payment_resource.rb
+- lib/starling/resources/transaction_resource.rb
 - lib/starling/services/account_balance_service.rb
 - lib/starling/services/account_service.rb
+- lib/starling/services/addresses_service.rb
 - lib/starling/services/base_service.rb
+- lib/starling/services/card_service.rb
+- lib/starling/services/contact_accounts_service.rb
+- lib/starling/services/contacts_service.rb
+- lib/starling/services/customer_service.rb
+- lib/starling/services/direct_debit_mandates_service.rb
+- lib/starling/services/direct_debit_transactions_service.rb
+- lib/starling/services/inbound_faster_payments_transactions_service.rb
+- lib/starling/services/mastercard_transactions_service.rb
+- lib/starling/services/me_service.rb
+- lib/starling/services/merchant_locations_service.rb
+- lib/starling/services/merchants_service.rb
+- lib/starling/services/outbound_faster_payments_transactions_service.rb
+- lib/starling/services/payments_service.rb
+- lib/starling/services/transactions_service.rb
+- lib/starling/utils.rb
 - lib/starling/version.rb
 - starling-ruby.gemspec
 homepage: https://github.com/timrogers/starling-ruby