app_report 0.0.2

data/test/app_report/api/base_test.rb

@@ -0,0 +1,147 @@
+require 'test_helper'
+require 'app_report/api/fake_api'
+
+class BaseAPITest < MiniTest::Unit::TestCase
+
+  def setup
+
+    AppReport.configure do |config|
+      config.app_name   = 'app'
+      config.access_key = 'L3jC1SHoo3mqWZ2kT7m4'
+      config.secret_key = '6zD1sMPAYJdBj/SUMqi/BIqayWkjx3PSV1KaQyND'
+    end
+
+    @base_api_class = AppReport::API::Base
+    @base_api       = @base_api_class.new
+
+
+    # using fake api to test custom params
+
+    @fake_api = AppReport::API::FakeAPI.new
+
+    @fake_api.params = {
+      :document => '123456789abc',
+      :id       => 123
+    }
+  end
+
+  def test_assignment_of_params
+    base_api = @base_api_class.new
+    assert_includes base_api.instance_variables, :@params
+  end
+
+  def test_params_to_sign_return_an_empty_array
+    assert_equal [], @base_api.params_to_sign
+  end
+
+  def test_sign_params_return_a_string
+    assert_kind_of String, @base_api.sign_params({})
+  end
+
+  def test_signed_params_is_a_hash
+    assert_kind_of Hash, @base_api.signed_params
+  end
+
+  def test_signed_params_include_configured_keys
+    signed_params = @base_api.signed_params
+
+    [:app_name, :access_key].each do |key|
+      assert_includes signed_params, key
+      assert_equal AppReport.settings.send(key), signed_params[key]
+    end
+  end
+
+  def test_signed_params_include_expires
+    signed_params = @base_api.signed_params
+    assert_includes signed_params, 'expires'
+  end
+
+  def test_configured_keys_not_overwritten_by_params
+    @base_api.params[:app_name]   = 'overwritten_app_name'
+    @base_api.params[:access_key] = 'overwritten_access_key'
+
+    signed_params = @base_api.signed_params
+
+    [:app_name, :access_key].each do |key|
+      assert_equal AppReport.settings.send(key), signed_params[key]
+    end
+  end
+
+  def test_expires_not_overwritten_by_params
+    expires                    = 100
+    @base_api.params[:expires] = expires
+    signed_params              = @base_api.signed_params
+
+    refute_equal expires, signed_params[:expires]
+  end
+
+
+  def test_signed_params_include_all_params_including_not_signed
+    @fake_api.params[:foo] = 'new param value'
+    signed_params          = @fake_api.signed_params
+
+    @fake_api.params.each do |key, value|
+      assert_includes signed_params, key
+    end
+  end
+
+  def test_signed_params_include_expires
+    assert_includes @base_api.signed_params, :expires
+  end
+
+  def test_signed_params_expires
+    expected   = Time.now.to_i + AppReport.settings.expires_signed_url_after
+    calculated = @base_api.signed_params[:expires]
+
+    assert_equal expected, calculated
+  end
+
+  def test_signed_params_include_signature
+    assert_includes @base_api.signed_params, :signature
+  end
+
+  def test_sign_params_signature
+    params = {
+      :foo => 'bar',
+      :hey => "what's up?"
+    }
+
+    params_string = params.map { |k, v| v.to_s }.join
+
+    expected_signature = SimpleSigner.sign \
+      :secret_key => AppReport.settings.secret_key,
+      :string     => params_string
+
+    given_signature = @base_api.sign_params params
+
+    assert_equal expected_signature, given_signature
+  end
+
+  def test_signed_params_signature
+
+    # expected
+
+    params = {}
+
+    @fake_api.params_to_sign.each { |param|
+      params[param] = @fake_api.params[param]
+    }
+
+    params.merge! :app_name   => AppReport.settings.app_name,
+                  :expires    => Time.now.to_i + AppReport.settings.expires_signed_url_after
+
+    params_string = params.map { |k, v| v.to_s }.join
+
+
+    expected_signature = SimpleSigner.sign \
+      :secret_key => AppReport.settings.secret_key,
+      :string     => params_string
+
+
+    # given
+
+    given_signature = @fake_api.signed_params[:signature]
+
+    assert_equal expected_signature, given_signature
+  end
+end

data/test/app_report/api/fake_api.rb

@@ -0,0 +1,14 @@
+
+# fake api used to test the AppReport::API::Base class
+
+module AppReport
+  module API
+    class FakeAPI < AppReport::API::Base
+
+      def params_to_sign
+        [:app_name, :access_key, :document, :id, :inexistent_param]
+      end
+
+    end
+  end
+end

data/test/app_report/api/jasper_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+require 'tempfile'
+
+class JasperAPITest < MiniTest::Unit::TestCase
+
+  def setup
+
+    AppReport.configure do |config|
+      config.app_name   = 'app-name'
+      config.access_key = 'access-key'
+      config.secret_key = 'secret-key'
+    end
+
+    @default_report_options = {
+      :template_name    => 'some_report',
+      :data_type        => 'xml',
+      :data             => '<?xml version="1.0" encoding="utf-8"?><root><node></node></root>',
+      :xpath_expression => '/root/node',
+      :args             => { :key => 'value' }
+    }
+
+    @api       = AppReport::API::Jasper.new
+    @report    = AppReport::Report::Jasper.new @default_report_options
+  end
+
+  def test_params_to_sign
+    params_to_sign = @api.params_to_sign
+
+    [:app_name, :template_name, :expires].each do |key|
+      assert_includes params_to_sign, key
+    end
+  end
+
+  # validation of report argument
+  def test_validation_of_report_arg
+    [:validates_report!, :build!].each do |method|
+      test_error_msg = "a validation error must be raised by #{method}"
+
+      assert_raises AppReport::Errors::ValidationError, test_error_msg do
+        @api.send method, nil
+      end
+    end
+  end
+
+  # report validation, build! must call the validates! method of the report.
+  def test_report_validation
+    report         = AppReport::Report::Jasper.new
+    test_error_msg = 'a validation error must be raised by report in build'
+
+    assert_raises AppReport::Errors::ValidationError, test_error_msg do
+      @api.build! report
+    end
+  end
+
+  def test_decode_blank_report_error
+    [nil, ''].each { |nil_or_empty|
+      response_body  = MultiJson.dump({ 'report' => nil_or_empty })
+      test_error_msg = "an error must be raised, when report is #{nil_or_empty.nil? ? 'nil' : 'empty'}"
+
+      assert_raises AppReport::Errors::APIResponseError, test_error_msg do
+        @api.decode_report! response_body
+      end
+    }
+  end
+
+  def test_decode_report
+    expected = 'hello, am I a report?'
+
+    response_body = MultiJson.dump({
+      'report' => {
+        'encoding' => 'base64',
+        'encoded'  => Base64.encode64(expected)
+      }
+    })
+
+    given = @api.decode_report! response_body
+
+    assert_equal expected, given
+  end
+
+  def test_build_set_report_attributes_as_params
+    stub_post('/api/v1/factory/jasper/build.json').to_return \
+      :body    => fixture('report.json'),
+      :headers => { :content_type => "application/json; charset=utf-8" }
+
+    @api.build! @report
+
+    @report.attributes.each do |key, value|
+      assert_includes @api.params, key
+      assert_equal @api.params[key], @report.attributes[key]
+    end
+  end
+
+
+  def test_build
+    stub_post('/api/v1/factory/jasper/build.json').to_return \
+      :body    => fixture('report.json'),
+      :headers => { :content_type => "application/json; charset=utf-8" }
+
+    expected_pdf_raw = fixture('report.pdf').read
+    given_pdf_raw    = @api.build! @report
+
+
+    # writting a file, because
+    # assert_equal(expected_pdf_raw, given_pdf_raw) fails
+    #
+    # probably it's not the best solution, but for now it works!
+
+    f = Tempfile.new 'given.pdf'
+
+    begin
+      f.write given_pdf_raw
+      f.rewind
+
+      assert_equal expected_pdf_raw, f.read
+    ensure
+      f.close
+    end
+  end
+
+end

data/test/app_report/client_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class ClientTest < MiniTest::Unit::TestCase
+
+  def test_default_endpoint
+    assert_equal \
+      'http://reports.simpleservic.es', 
+      AppReport::Client.endpoint
+  end
+
+  def test_connection_return_faraday_connection
+    assert_kind_of Faraday::Connection, AppReport::Client.connection 
+  end
+
+  def test_post_return_faraday_response
+    path = '/faraday_response.json'
+
+    stub_post(path).to_return \
+      :body    => {}, 
+      :headers => { :content_type => "application/json; charset=utf-8" }
+
+    assert_kind_of Faraday::Response, AppReport::Client.post(path, {})
+  end
+
+  def test_raise_error_messages
+    assert_raises AppReport::Errors::APIError do
+      AppReport::Client.raise_error_messages! fixture('error_messages.json')
+    end
+  end
+
+  def test_post_raise_error_messages
+    path = '/error_messages.json'
+
+    stub_post(path).to_return \
+      :body    => fixture('error_messages.json'), 
+      :headers => { :content_type => "application/json; charset=utf-8" }
+
+    assert_raises AppReport::Errors::APIError do
+      AppReport::Client.post(path, {})
+    end
+  end
+
+end

data/test/app_report/configuration_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class ConfigurationTest < MiniTest::Unit::TestCase
+
+  def setup
+    @configuration_class = AppReport::Configuration
+
+    @default_settings = {
+      :app_name   => 'app',
+      :access_key => '123',
+      :secret_key => '123abc'
+    }
+  end
+
+  def test_response_to_config_keys
+    assert_respond_to @configuration_class, :config_keys
+  end
+
+  def test_immutability_of_config_keys
+    @configuration_class.config_keys.delete :app_name
+    assert_includes @configuration_class.config_keys, :app_name
+  end
+
+  def test_response_to_each_config_keys
+    @configuration_class.config_keys.each do |key|
+      assert_respond_to @configuration_class, key
+    end
+  end
+
+  def test_response_to_validates
+    assert_respond_to @configuration_class, :validates!
+  end
+
+  def test_validation_of_expires_signed_url_after
+    assert_raises AppReport::Errors::InvalidConfigurationError do
+      @configuration_class.expires_signed_url_after = nil
+    end
+  end
+
+  def test_validation_of_required_keys
+    @configuration_class.config_keys.each { |key|
+      next if key == :expires_signed_url_after
+
+      @default_settings.each do |k, v|
+        @configuration_class.send "#{k}=", v
+      end
+
+      @configuration_class.send "#{key}=", nil
+
+      test_error_msg = "a RequiredConfigurationError must be raised when #{key} is empty"
+      assert_raises AppReport::Errors::RequiredConfigurationError, test_error_msg do
+        @configuration_class.validates!
+      end
+    }
+  end
+
+  def test_default_expires_signed_url_after_value
+    assert_equal 600, @configuration_class.expires_signed_url_after
+  end
+
+end

data/test/app_report/decoder_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class DecoderTest < MiniTest::Unit::TestCase
+
+  def test_decode_base64
+    expected = 'Boring string...'
+    encoded  = Base64.encode64(expected)
+    given    = AppReport::Decoder.decode_base64 encoded
+
+    assert_equal expected, given
+  end
+
+  def test_decode_blank_encoded_error
+    [nil, ''].each { |nil_or_empty|
+      test_error_msg = "an error must be raised, when encoded is #{nil_or_empty.nil? ? 'nil' : 'empty'}"
+
+      assert_raises AppReport::Errors::DecoderError, test_error_msg do
+        AppReport::Decoder.decode nil_or_empty
+      end
+    }
+  end
+
+  def test_decode_blank_encoding_error
+    [nil, ''].each { |nil_or_empty|
+      test_error_msg = "an error must be raised, when encoding is #{nil_or_empty.nil? ? 'nil' : 'empty'}"
+
+      assert_raises AppReport::Errors::DecoderError, test_error_msg do
+        AppReport::Decoder.decode 'encoded', nil_or_empty
+      end
+    }
+  end
+
+  def test_decode_with_base64_encoding
+    expected = "Sexy string!"
+    encoded  = Base64.encode64(expected)
+    given    = AppReport::Decoder.decode encoded, 'base64'
+
+    assert_equal expected, given
+  end
+
+  def test_unsupported_encoding_error
+    assert_raises AppReport::Errors::DecoderError do
+      AppReport::Decoder.decode 'str', 'unsuported-encoding'
+    end
+  end
+
+end

data/test/app_report/report/jasper_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class JasperReportTest < MiniTest::Unit::TestCase
+
+  def setup
+
+    @default_attributes = {
+      :template_name    => 'my_super_template',
+      :data_type        => 'xml',
+      :data             => '<?xml version="1.0" encoding="utf-8"?><root><node></node></root>',
+      :xpath_expression => '/root/node',
+      :args             => { :key => 'value' }
+    }
+
+    @report_class    = AppReport::Report::Jasper
+    @report          = @report_class.new @default_attributes
+  end
+
+
+  # attributes
+
+  def test_assignment_of_attributes
+    report = @report_class.new
+    assert_includes report.instance_variables, :@attributes
+  end
+
+  def test_response_to_attributes
+    assert_respond_to @report, :attributes
+  end
+
+  def test_immutability_of_attributes_hash
+    @report.attributes[:template_name] = 'it_was_overwritten!'
+    refute_equal @report.template_name, 'it_was_overwritten!'
+  end
+
+  def test_response_to_each_option
+    @report.attributes.each do |key, value|
+      assert_respond_to @report, key, "report must respond to #{key}"
+    end
+  end
+
+  def test_return_of_each_option
+    @report.attributes.each do |key, value|
+      assert_equal value, @report.send(key), "#{key} must return the value sent for #{key} option"
+    end
+  end
+
+
+  # validations
+
+  def test_response_to_validates_each_option
+    @report.attributes.each do |key, value|
+      method = "validates_#{key}!"
+      assert_respond_to @report, method, "report must respond to #{method}"
+    end
+  end
+
+  def test_response_to_validates_all_attributes
+    assert_respond_to @report, :validates_all_attributes!
+  end
+
+  def test_response_to_alias_of_validates_all_attributes
+    assert_respond_to @report, :validates!
+  end
+
+  def test_response_to_validates_presence_of
+    assert_respond_to @report, :validates_presence_of!
+  end
+
+  def test_validation_of_template_name
+    report = @report_class.new @default_attributes.except :template_name
+
+    [:validates_template_name!, :validates_all_attributes!, :validates! ].each do |method|
+      test_error_msg = "a validation error must be raised by #{method}"
+
+      assert_raises AppReport::Errors::ValidationError, test_error_msg do
+        report.send method
+      end
+    end
+  end
+
+  # TODO test validation of other attributes in client side.
+end

data/test/app_report_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class AppReportTest < MiniTest::Unit::TestCase
+
+  def setup
+    AppReport.configure do |config|
+      config.app_name   = 'app'
+      config.access_key = '123'
+      config.secret_key = '123abc'
+    end
+  end
+
+  def test_response_to_configure
+    assert_respond_to AppReport, :configure
+  end
+
+  def test_configure_block_yields_configuration
+    AppReport.configure do |config|
+      assert_equal AppReport::Configuration, config
+    end
+  end
+
+  def test_response_to_settings
+    assert_respond_to AppReport, :settings
+  end
+
+  def test_settings_return_configuration
+    assert_equal AppReport::Configuration, AppReport::settings
+  end
+
+  def test_configure_block_change_settings
+    AppReport.configure do |config|
+      config.app_name = 'app_name1'
+    end
+
+    assert_equal 'app_name1', AppReport.settings.app_name
+  end
+
+  def test_settings_changed_via_atributes
+    AppReport.settings.app_name = 'app_name2'
+
+    AppReport.configure do |config|
+      assert_equal 'app_name2', config.app_name
+    end
+  end
+
+  def test_settings_validation
+    assert_raises AppReport::Errors::RequiredConfigurationError do
+      AppReport.configure do |config|
+        config.app_name = nil
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'minitest/colorize'
+require 'webmock/minitest'
+require 'app_report'
+
+def stub_post(path)
+  stub_request(:post, AppReport::Client::endpoint + path)
+end
+
+def fixture_path
+  File.expand_path '../fixtures', __FILE__
+end
+
+def fixture file
+  File.new File.join(fixture_path, file)
+end