rconomic 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a313ca9c76fdc8960400e6fcadaf28ec6f95cc9d2a384ad23e10dac7f5fa437
-  data.tar.gz: 9978cf2741e44bbfb27b2a0bae8897cc47ea145a266eb5d5efb2a59473ac8fb4
+  metadata.gz: 2f1a219e94882985de0e54c405e83d38f41f143fb15aaea9d411aa1b1c48acf9
+  data.tar.gz: beafac33256aad1ad07d84f1c5e3695c29020748adf85ab9f6e06896d648549e
 SHA512:
-  metadata.gz: 5f37f47e568b52d750b902461e32710046cb607b65c2f239dc6a2429f9591d2d9db910211fedaae68818772b7955c62416155ff02dd9356e5c06ad347f2fe4c3
-  data.tar.gz: b401ccbdcd48c1e4b901b716a9d953bc7176dd58e1aacb6a14a72a263c3a5de63e305b8728df2e1ba1c011732d3dd08d98a8246652a64f8926a890af9b5e00f2
+  metadata.gz: 7ba0dedca0390d08d94ccba9996b8189e48f48c099ea98aad37c2d1e287a1ef44a291257e5c988cb1c6bb8700fba56c161b4c9e7e5e624484efde73b32def53a
+  data.tar.gz: 7ada580604da2cf3a9fbe8a4d64febd2e1df680adb9976a7511cf3b56cba02abe484e523a17d5cac5c116f650b47c687d6f43e45500d9fb76b95d04ccff3df70

data/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+
+### Added
+
+*
+
+### Changes
+
+*
+
+### Removed
+
+## 0.7.0 [July 1st, 2018]
+
+This release contains breaking changes as E-conomic has deprecated one of their connection methods. See https://www.e-conomic.com/developer#_ga=2.79896535.1117342868.1530474675-2146547048.1526554784 for details.
+
+### Removed
+
+* Ability to connect with agreement number, username and password. You need to use `Economic::Session#connect_with_token` going forward.
+* Ability to set an app identifier. This was tied to the now removed `Economic::Session#connect_with_credentials` method.
+
 ## 0.6.1 [July 1st, 2018]
 
 ### Changes

data/README.md

@@ -13,11 +13,7 @@ Usage example
 
     economic = Economic::Session.new
 
-    # After 16 November 2015, you must supply an 'Application ID' with #connect_with_credentials
-    # As described here: http://techtalk.e-conomic.com/e-conomic-soap-api-now-requires-you-to-specify-a-custom-x-economicappidentifier-header/
-    economic.connect_with_credentials(123456, 'API', 'passw0rd', 'my awesome integration v1.0.0')
-
-    # Or connect using a Private app ID and an access ID provided by the "Grant Access"
+    # Connect using a Private app ID and an access ID provided by the "Grant Access"
     # As described here: http://www.e-conomic.com/developer/tutorials
     economic = Economic::Session.new
     economic.connect_with_token 'the_private_app_id', 'the_access_id_you_got_from_the_grant'
@@ -96,10 +92,10 @@ Usage example
 How to enable e-conomic API access
 ----------------------------------
 
-You need to enable API access in e-conomic before you can, well, use the API. Otherwise you'll be getting access denied errors when connecting.
-
-Just follow the instructions on [e-copedia](http://wiki.e-conomic.co.uk/add-on-modules/) to enable the API Add-on module.
+You need a Developer account and setup an app in their web UI. E-conomic users can then grant that app access to their account.
 
+* Developer portal: https://www.e-conomic.com/developer
+* Instructions: https://www.e-conomic.com/developer/connect
 
 It doesn't do everything
 ------------------------

data/lib/economic/endpoint.rb

@@ -11,13 +11,7 @@ class Economic::Endpoint
   # Create a new Endpoint
   #
   # Economic::Session uses this internally
-  #
-  # ==== Attributes
-  #
-  # * +app_identifier+ - A string identifiying your application, as described in http://techtalk.e-conomic.com/e-conomic-soap-api-now-requires-you-to-specify-a-custom-x-economicappidentifier-header/
-  #
-  def initialize(app_identifier = nil)
-    @app_identifier = app_identifier
+  def initialize
   end
 
   # Invokes soap_action on the API endpoint with the given data.
@@ -48,9 +42,6 @@ class Economic::Endpoint
   def client(force_new_instance: false)
     reset_client if force_new_instance
     options = client_options
-    if @app_identifier
-      options[:headers] = {"X-EconomicAppIdentifier" => @app_identifier}
-    end
     @@client ||= Savon.client(options)
   end
 

data/lib/economic/session.rb

@@ -8,14 +8,9 @@ module Economic
 
     def_delegators :endpoint, :logger=, :log_level=, :log=
 
-    attr_accessor :agreement_number, :user_name, :password, :app_identifier
     attr_reader :authentication_cookies
 
-    def initialize(agreement_number = nil, user_name = nil, password = nil, app_identifier = nil)
-      self.agreement_number = agreement_number
-      self.user_name = user_name
-      self.password = password
-      self.app_identifier = app_identifier
+    def initialize
       yield endpoint if block_given?
     end
 
@@ -38,34 +33,6 @@ module Economic
       end
     end
 
-    # Connect/authenticate with credentials
-    #
-    # ==== Attributes
-    #
-    # * +agreement_number+ - your economic agreement number
-    # * +user_name+ - your username
-    # * +password+ - your passsword
-    # * +app_identifier+ - A string identifiying your application, as described in http://techtalk.e-conomic.com/e-conomic-soap-api-now-requires-you-to-specify-a-custom-x-economicappidentifier-header/
-    #
-    def connect_with_credentials(agreement_number, user_name, password, app_identifier = nil)
-      self.app_identifier = app_identifier if app_identifier
-
-      endpoint.call(
-        :connect,
-        :agreementNumber => agreement_number,
-        :userName => user_name,
-        :password => password
-      ) do |response|
-        store_authentication_cookies(response)
-      end
-    end
-
-    # Authenticates with E-conomic using credentials
-    # Assumes ::new was called with credentials as arguments.
-    def connect
-      connect_with_credentials(agreement_number, user_name, password, app_identifier)
-    end
-
     # Provides access to the DebtorContacts
     def contacts
       @contacts ||= DebtorContactProxy.new(self)
@@ -142,7 +109,7 @@ module Economic
 
     # Returns the SOAP endpoint to connect to
     def endpoint
-      @endpoint ||= Economic::Endpoint.new(app_identifier)
+      @endpoint ||= Economic::Endpoint.new
     end
 
     private

data/lib/rconomic.rb

@@ -1,7 +1,6 @@
 # Dependencies
 require "time"
 require "savon"
-require "savon_ext/request"
 
 require "economic/support/string"
 require "economic/session"

data/lib/rconomic/version.rb

@@ -1,3 +1,3 @@
 module Rconomic
-  VERSION = "0.6.1".freeze
+  VERSION = "0.7.0".freeze
 end

data/rconomic.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.version     = Rconomic::VERSION
   s.platform    = Gem::Platform::RUBY
 
-  s.add_runtime_dependency "savon", "~> 2.2", "< 2.11.2"
+  s.add_runtime_dependency "savon", "~> 2.2"
   s.add_development_dependency "rspec", "> 3.0"
 
   s.files         = `git ls-files`.split("\n").reject { |filename| [".gitignore"].include?(filename) }

data/spec/economic/endpoint_spec.rb

@@ -86,20 +86,4 @@ describe Economic::Endpoint do
       subject.logger = logger
     end
   end
-
-  describe "app identifier configuration" do
-    let(:app_id) { "my awesome app v.4.0.9-beta-rc1" }
-
-    subject {
-      described_class.new(app_id)
-    }
-
-    it "adds the app identifier HTTP headers" do
-      client = subject.client(:force_new_instance => true)
-      globals = client.globals
-      expect(
-        globals[:headers]["X-EconomicAppIdentifier"]
-      ).to eq(app_id)
-    end
-  end
 end

data/spec/economic/session_spec.rb

@@ -1,99 +1,20 @@
 require "./spec/spec_helper"
 
 describe Economic::Session do
-  let(:credentials) { [123_456, "api", "passw0rd"] }
   subject { Economic::Session.new }
 
   let(:endpoint) { subject.endpoint }
 
   describe "new" do
-    describe "legacy connect" do
-      subject { Economic::Session.new(*credentials) }
-      it "should store authentication details" do
-        expect(subject.agreement_number).to eq(123_456)
-        expect(subject.user_name).to eq("api")
-        expect(subject.password).to eq("passw0rd")
-      end
-
-      it "can also store an app_id" do
-        session = Economic::Session.new(*credentials, "app_id")
-        expect(session.app_identifier).to eq("app_id")
-      end
-    end
-
     it "yields the endpoint if a block is given" do
       endpoint_mock = double("Endpoint")
       allow(Economic::Endpoint).to receive(:new).and_return(endpoint_mock)
       expect {|b|
-        Economic::Session.new(123_456, "api", "passw0rd", &b)
+        Economic::Session.new(&b)
       }.to yield_with_args(endpoint_mock)
     end
   end
 
-  describe "connect" do
-    let(:authentication_details) {
-      {
-        :agreementNumber => 123_456,
-        :userName => "api",
-        :password => "passw0rd"
-      }
-    }
-
-    it "can connect old-style" do
-      mock_request(:connect, authentication_details, :success)
-      e = Economic::Session.new(*credentials)
-      e.connect
-    end
-
-    it "connects to e-conomic with authentication details" do
-      mock_request(:connect, authentication_details, :success)
-      subject.connect_with_credentials(*credentials)
-    end
-
-    it "stores the authentication token for later requests" do
-      response = {
-        :headers => {"Set-Cookie" => "cookie value from e-conomic"},
-        :body => fixture(:connect, :success)
-      }
-      stub_request("Connect", authentication_details, response)
-
-      subject.connect_with_credentials(*credentials)
-
-      expect(subject.authentication_cookies.collect { |cookie|
-        cookie.name_and_value.split("=").last
-      }).to eq(["cookie value from e-conomic"])
-    end
-
-    it "updates the authentication token for new sessions" do
-      stub_request(
-        "Connect",
-        nil,
-        :headers => {"Set-Cookie" => "authentication token"}
-      )
-      subject.connect_with_credentials(*credentials)
-
-      stub_request(
-        "Connect",
-        nil,
-        :headers => {"Set-Cookie" => "another token"}
-      )
-      other_session = Economic::Session.new
-      other_session.connect_with_credentials(123_456, "api", "passw0rd")
-
-      expect(subject.authentication_cookies.collect { |cookie|
-        cookie.name_and_value.split("=").last
-      }).to eq(["authentication token"])
-      expect(other_session.authentication_cookies.collect { |cookie|
-        cookie.name_and_value.split("=").last
-      }).to eq(["another token"])
-    end
-
-    it "doesn't use existing authentication details when connecting" do
-      expect(endpoint).to receive(:call).with(:connect, instance_of(Hash))
-      subject.connect_with_credentials(*credentials)
-    end
-  end
-
   describe "connecting with access ID" do
     # As per http://www.e-conomic.com/developer/tutorials
     let(:authentication_details) {
@@ -124,30 +45,6 @@ describe Economic::Session do
       }).to eq(["cookie value from e-conomic"])
     end
 
-    it "updates the authentication token for new sessions" do
-      stub_request(
-        "ConnectWithToken",
-        nil,
-        :headers => {"Set-Cookie" => "authentication token"}
-      )
-      subject.connect_with_token private_app_id, access_id
-
-      stub_request(
-        "Connect",
-        nil,
-        :headers => {"Set-Cookie" => "another token"}
-      )
-      other_session = Economic::Session.new
-      other_session.connect_with_credentials(123_456, "api", "passw0rd")
-
-      expect(subject.authentication_cookies.collect { |cookie|
-        cookie.name_and_value.split("=").last
-      }).to eq(["authentication token"])
-      expect(other_session.authentication_cookies.collect { |cookie|
-        cookie.name_and_value.split("=").last
-      }).to eq(["another token"])
-    end
-
     it "doesn't use existing authentication details when connecting" do
       expect(endpoint).to receive(:call).with(
         :connect_with_token,

data/spec/support/factories.rb

@@ -61,5 +61,5 @@ def make_debtor(properties = {})
 end
 
 def make_session
-  Economic::Session.new(123_456, "api", "passw0rd")
+  Economic::Session.new
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rconomic
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jakob Skjerning
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.11.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +105,6 @@ files:
 - lib/economic/support/string.rb
 - lib/rconomic.rb
 - lib/rconomic/version.rb
-- lib/savon_ext/request.rb
 - rconomic.gemspec
 - spec/economic/account_spec.rb
 - spec/economic/cash_book_entry_spec.rb

data/lib/savon_ext/request.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Savon
-  class SOAPRequest < HTTPRequest
-    def build(options = {})
-      configure_proxy
-      configure_timeouts
-      configure_headers options[:soap_action]
-      configure_cookies options[:cookies]
-      configure_ssl
-      configure_auth
-      configure_redirect_handling
-
-      @http_request
-    end
-  end
-end