app_report 0.0.2

data/COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir['test/**/*_test.rb']
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/app_report.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = "app_report"
+  s.version     = "0.0.2"
+  s.description = "Ruby client to AppReport API!"
+  s.summary     = "App Report!"
+  s.author      = "Lucas D'Avila"
+  s.email       = 'lucas@lucasdavi.la'
+  s.homepage    = 'https://github.com/simple_services/app_report-ruby'
+  s.files       = Dir["{lib/**/*.rb,README.rdoc,test/**/*.rb,Rakefile,*.gemspec,COPYING}"]
+
+  s.add_development_dependency 'minitest', '~> 4.6.1'
+  s.add_development_dependency 'minitest-colorize', '~> 0.0.5'
+  s.add_development_dependency 'webmock', '~> 1.10.0'
+
+  s.add_dependency 'active_support', '~> 3.0.0'
+  s.add_dependency 'simple_signer', '~> 0.0.1'
+  s.add_dependency 'faraday', '~> 0.8.6'
+  s.add_dependency 'multi_json', '~> 1.0'
+end

data/lib/app_report/api/base.rb

@@ -0,0 +1,57 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module API
+    class Base
+
+      attr_accessor :params
+
+      def initialize
+        @params = {}
+      end
+
+      def params_to_sign
+        []
+      end
+
+      def sign_params params
+        string = params.map { |k, v| v.to_s }.join
+        SimpleSigner.sign :secret_key => AppReport.settings.secret_key, :string => string
+      end
+
+      def signed_params
+        params = {}
+
+        # include params that must be signed
+        params_to_sign.each { |param|
+          params[param] = @params[param]#  unless params.include? param
+        }
+
+        # include configured keys
+        params.merge! :app_name   => AppReport.settings.app_name,
+                      :expires    => Time.now.to_i + AppReport.settings.expires_signed_url_after
+
+        # sign params
+        params.merge! :signature  => sign_params(params),
+                      :access_key => AppReport.settings.access_key
+
+        # include not signed params
+        @params.merge params
+      end
+    end
+  end
+end

data/lib/app_report/api/jasper.rb

@@ -0,0 +1,61 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module API
+    class Jasper < AppReport::API::Base
+
+      def params_to_sign
+       [:app_name, :template_name, :expires]
+      end
+
+      def build! report
+
+        @report = report
+        validates_report! @report
+        @report.validates!
+
+        @params = @report.attributes
+
+        path     = '/api/v1/factory/jasper/build.json'
+        response = AppReport::Client.post path, signed_params
+
+        decode_report! response.body
+      end
+
+      def decode_report! response_body
+        response_body = MultiJson.load response_body
+        report        = response_body['report']
+
+        if report.blank?
+          raise AppReport::Errors::APIResponseError, "API returned a blank report!"
+        end
+
+        AppReport::Decoder.decode report['encoded'], report['encoding']
+      end
+
+      # validations
+
+      def validates_report! report
+        unless report.kind_of? AppReport::Report::Jasper
+          error_msg = "report must be a instance of AppReport::Report::Jasper not #{report.class.name}"
+          raise AppReport::Errors::ValidationError, error_msg
+        end
+      end
+
+    end
+  end
+end

data/lib/app_report/client.rb

@@ -0,0 +1,63 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module Client
+
+    @@connection = nil
+    @@endpoint   = 'http://reports.simpleservic.es'
+
+    mattr_accessor :endpoint
+
+    def self.post path, params = {}
+      response = connection.post do |request|
+        request.url path
+
+        request.headers['Content-Type'] = 'application/json'
+        request.body                    = MultiJson.dump params
+      end
+
+      raise_error_messages! response.body
+
+      response
+    end
+
+    def self.connection
+      if @@connection.nil?
+        @@connection = Faraday.new(:url => @@endpoint) { |faraday|
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter # same as :net_http
+        }
+      end
+
+      @@connection
+    end
+
+    def self.raise_error_messages! response_body
+      response_body = MultiJson.load response_body
+
+      if response_body.try(:[], 'messages').try(:[], 'has_any_error')
+        error_messages = response_body['messages']['messages'].map { |m|
+          m['message']
+        }
+
+        raise AppReport::Errors::APIError, \
+          "AppReport API error: #{error_messages}"
+      end
+    end
+
+  end
+end

data/lib/app_report/configuration.rb

@@ -0,0 +1,53 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module Configuration
+
+    @@config_keys = [
+      :app_name,
+      :access_key,
+      :secret_key,
+      :expires_signed_url_after
+    ]
+
+    mattr_accessor *@@config_keys
+
+    # default values
+
+    # expire urls after 10 minutes, by default.
+    @@expires_signed_url_after = 600
+
+    def self.expires_signed_url_after= value
+      unless value.kind_of? Integer and value > 0
+       raise AppReport::Errors::InvalidConfigurationError, "value must be an integer > 0, not #{value}"
+      end
+
+      @@expires_signed_url_after = value
+    end
+
+    def self.config_keys
+      @@config_keys.clone
+    end
+
+    def self.validates!
+      config_keys.each do |key|
+        raise AppReport::Errors::RequiredConfigurationError, "#{key} is required" if send(key).blank?
+      end
+    end
+
+  end
+end

data/lib/app_report/decoder.rb

@@ -0,0 +1,41 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module Decoder
+
+    def self.decode encoded, encoding = 'base64'
+      supported = ['base64']
+
+      if encoded.blank?
+        raise AppReport::Errors::DecoderError, "Encoded can't be blank"
+
+      elsif encoding.blank?
+        raise AppReport::Errors::DecoderError, "Encoding can't be blank!"
+
+      elsif not supported.include? encoding
+        raise AppReport::Errors::DecoderError, "Encoding '#{encoding}' not supported, only #{supported}."
+      end
+
+      send "decode_#{encoding}", encoded
+    end
+
+    def self.decode_base64 encoded
+      Base64.decode64 encoded
+    end
+
+  end
+end

data/lib/app_report/errors.rb

@@ -0,0 +1,56 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module Errors
+    class AppReportError < StandardError
+    end
+
+
+    # validation
+
+    class ValidationError < AppReportError
+    end
+
+
+    # configuration
+
+    class ConfigurationError < AppReportError
+    end
+
+    class RequiredConfigurationError < ConfigurationError
+    end
+
+    class InvalidConfigurationError < ConfigurationError
+    end
+
+
+    # API
+
+    class APIError < AppReportError
+    end
+
+    class APIResponseError < APIError
+    end
+
+
+    # decoder
+
+    class DecoderError < AppReportError
+    end
+
+  end
+end

data/lib/app_report/report/jasper.rb

@@ -0,0 +1,93 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module AppReport
+  module Report
+
+    class Jasper
+
+      def initialize attributes = {}
+        attributes = {
+          :template_name    => nil,
+          :data_type        => 'empty',
+          :data             => '',
+          :xpath_expression => '',
+          :args             => {}
+        }.merge attributes
+
+        @attributes = attributes
+      end
+
+      # attributes
+
+      def attributes
+        @attributes.clone
+      end
+
+      def template_name
+        @attributes[:template_name]
+      end
+
+      def data_type
+        @attributes[:data_type]
+      end
+
+      def data
+        @attributes[:data]
+      end
+
+      def xpath_expression
+        @attributes[:xpath_expression]
+      end
+
+      def args
+        @attributes[:args]
+      end
+
+
+      # validations
+
+      def validates_all_attributes!
+        @attributes.each do |key, value|
+          send "validates_#{key}!"
+        end
+      end
+      alias validates! validates_all_attributes!
+
+      def validates_presence_of! option_name
+        raise AppReport::Errors::ValidationError, "#{option_name} is required" if send(option_name).blank?
+      end
+
+      def validates_template_name!
+        validates_presence_of! :template_name
+      end
+
+      def validates_data_type!
+      end
+
+      def validates_data!
+      end
+
+      def validates_xpath_expression!
+      end
+
+      def validates_args!
+      end
+
+    end
+
+  end
+end

data/lib/app_report.rb

@@ -0,0 +1,48 @@
+=begin
+This file is part of AppReport.
+
+AppReport is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+AppReport is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with AppReport.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/try'
+
+require 'simple_signer'
+require 'multi_json'
+require 'faraday'
+
+require 'base64'
+
+require 'app_report/errors'
+require 'app_report/configuration'
+require 'app_report/client'
+require 'app_report/decoder'
+require 'app_report/api/base'
+require 'app_report/api/jasper'
+require 'app_report/report/jasper'
+
+module AppReport
+
+  def self.configure
+    yield AppReport::Configuration
+
+    AppReport::Configuration.validates!
+    AppReport::Configuration
+  end
+
+  def self.settings
+    AppReport::Configuration
+  end
+end