s3-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cf1d0b275e685af128afca81c1cbd26ac213209
+  data.tar.gz: b1846d86259e5aa9864885fa3974c4e0fd38cc3f
+SHA512:
+  metadata.gz: b5f73d5ba9d415266928e66df11dcc287e15011e4047c8a855c96855589c43df4717c9d8b5d90b6a53edc485df68d803cdd7e6625ffed1d9deac8dfa6eb27ebd
+  data.tar.gz: 017ffabe31a5f2ee5c9925f29c34ef9eac911fe2ab73ce946daf2c9a94ccd36580f417a2e22710d82af020e4fa25b49155ddcdcebcf4cfe0cc7b2e1e7b5e2d60

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.idea

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'timecop'
+  gem 'pry', '< 0.10.0'
+  gem 'pry-byebug'
+  gem 'webmock'
+  gem 'simplecov'
+  gem 'simplecov-rcov'
+  gem 'spork'
+end

data/LICENSE.txt

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/Rakefile

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+#
+#require "bundler/setup"
+
+# gem install tasks, but remove "release"
+#Rake::Task[:release].clear
+
+#$:.unshift File.expand_path("../lib", __FILE__)
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+
+task :doc => "document:build"
+
+namespace :spec do
+  [:api, :client, :models].each do |dir|
+    desc "Run #{dir} spec"
+    RSpec::Core::RakeTask.new(dir) do |t|
+      t.pattern = "spec/#{dir}/*_spec.rb"
+    end
+  end
+
+  task :without_sample => ['spec:api', 'spec:client', 'spec:models']
+end
+
+namespace :document do
+  task :build do
+    docpath = "../documents/parser"
+    if Dir.exist? docpath
+      pid = spawn("yard", "-o", docpath, STDERR => STDOUT)
+      Process.waitpid pid
+    else
+      puts "You don't have #{docpath} directory."
+      puts "Can't create a new document."
+    end
+  end
+end

data/config/settings.yml

@@ -0,0 +1,11 @@
+defaults: &defaults
+  endpoint: 'https://s3.ap-northeast-1.amazonaws.com'
+  force_path_style: false
+  debug: false
+  location: ap-northeast-1
+
+test:
+  <<: *defaults
+  endpoint: 'http://localhost:9292'
+  force_path_style: true
+  location: localhost

data/lib/s3/client.rb

@@ -0,0 +1,31 @@
+require 'driver'
+require 's3/settings'
+require 's3/version'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/object/to_query'
+
+module S3
+  class Client < Driver::Client
+    drive Storage
+
+    # Constructor
+    # @param [String] access_key_id AccessKeyId
+    # @param [String] secret_access_key SecretAccessKey
+    # @param [Hash] options Options
+    def initialize(access_key_id, secret_access_key, **options)
+      require 's3/client/exception'
+      require 'ostruct'
+
+      @api = API.new(access_key_id, secret_access_key, options)
+
+      self
+    end
+
+    attr_reader :api
+
+    require "forwardable"
+    extend Forwardable
+    def_delegators :@api, *%w(access_key_id secret_access_key endpoint).flat_map { |a| [a, a+?=] }.map(&:intern)
+  end
+end

data/lib/s3/client/api.rb

@@ -0,0 +1,258 @@
+module S3
+  class Client
+    class API < Driver::API
+      drive Storage
+
+      autoload :RestParameter, 's3/client/api/rest_parameter'
+
+      def initialize(access_key_id, secret_access_key,
+                     endpoint: S3::Settings.endpoint,
+                     force_path_style: S3::Settings.force_path_style,
+                     location: S3::Settings.location,
+                     debug: S3::Settings.debug)
+
+        require 'time'
+        require 'base64'
+        require 'rexml/document'
+        require 'net/http'
+        require 'xmlsimple'
+        require 'ipaddr'
+        require 'httpclient'
+        require 'stringio'
+
+        @access_key_id = access_key_id
+        @secret_access_key = secret_access_key
+
+        unless [TrueClass, FalseClass].any? { |c| force_path_style.kind_of?(c) }
+           raise S3::Client::APIOptionInvalid.new("force_path_style is not boolean:#{force_path_style}")
+        end
+
+        unless [TrueClass, FalseClass].any? { |c| debug.kind_of?(c) }
+          raise S3::Client::APIOptionInvalid.new("debug is not boolean:#{debug}")
+        end
+
+        @endpoint = endpoint
+        @force_path_style = force_path_style
+        @location = location
+        @debug = debug
+
+        @http_client = HTTPClient.new
+        @http_client.connect_timeout = 300
+        @http_client.send_timeout    = 300
+        @http_client.receive_timeout = 300
+        @http_client.debug_dev = STDERR if @debug
+      end
+
+      attr_accessor :access_key_id, :secret_access_key, :endpoint
+
+      def force_path_style?
+        @force_path_style
+      end
+
+      def execute_storage(rest_parameter, &block)
+        unless @access_key_id
+           raise S3::Client::ParameterInvalid.new("missing access_key_id")
+        end
+
+        unless @secret_access_key
+           raise S3::Client::ParameterInvalid.new("missing secret_access_key")
+        end
+
+        response = handle_api_failure(rest_parameter) do
+          rest_client(:storage, rest_parameter, &block)
+        end
+
+        if response.present?
+          data = if rest_parameter.raw_data?
+                   response.body
+                 else
+                   REXML::Document.new(response.body)
+                 end || ''
+
+          if data.present?
+            STDERR.print "\n\n" if @debug
+          end
+
+          data.instance_eval {
+            class << self
+              attr_accessor :headers
+            end
+          }
+          data.headers = response.header
+          return data.freeze
+        end
+      end
+
+      def download_signature(expire_at, bucket, output_object)
+        http_verb = "GET\n"
+        content_md5 = "\n"
+        content_type = "\n"
+        expire = "#{expire_at}\n"
+
+        string_to_sign = http_verb + content_md5 + content_type + expire +
+            canonicalized_resource(bucket, output_object)
+
+        digest = OpenSSL::HMAC::digest(OpenSSL::Digest::SHA1.new, @secret_access_key, string_to_sign)
+        Base64.encode64(digest).strip
+      end
+
+      private
+
+      def canonicalized_resource(bucket, object)
+        result = ''
+
+        unless @force_path_style
+          result = '/'
+          result += "#{bucket}"
+        end
+
+        File.join(result, object)
+      end
+
+      # API Error Handling
+      # @param [S3::Client::API::RestParameter] rest_parameter APIへの入力値
+      # @param [Proc] block リクエスト処理が入るブロック
+      def handle_api_failure(rest_parameter, &block)
+        response = nil
+
+        begin
+          response = block.call
+
+          #unless response.try(:status).to_s =~ /^(2\d\d|3\d\d)$/
+          unless response.try(:status).to_s =~ /^(2\d\d)$/
+            raise S3::Client::APIFailure
+          end
+
+          return response
+        rescue S3::Client::APIFailure
+          msg = "api_failure #{rest_parameter}"
+          api_failure = S3::Client::APIFailure.new(msg)
+          raise api_failure if response.blank?
+
+          xml_doc = REXML::Document.new(response.body)
+
+          if xml_doc && xml_doc.elements['Error/Code']
+            if xml_doc.elements['Error/Code']
+              api_failure.api_code = xml_doc.elements['Error/Code'].text
+            end
+            if xml_doc.elements['Error/Message']
+              api_failure.api_message = xml_doc.elements['Error/Message'].text
+            end
+            if xml_doc.elements['Error/Status']
+              api_failure.api_status = xml_doc.elements['Error/Status'].text.to_i
+            end
+            if xml_doc.elements['Error/RequestId']
+              api_failure.api_request_id = xml_doc.elements['Error/RequestId'].text
+            end
+            if xml_doc.elements['Error/Resource']
+              api_failure.api_resource = xml_doc.elements['Error/Resource'].text
+            end
+          else
+            api_failure.api_code = nil
+            api_failure.api_message = response.body
+            api_failure.api_status = response.try(:status)
+            api_failure.api_request_id = nil
+            api_failure.api_resource = response.http_header.request_uri
+          end
+
+          raise api_failure
+        end
+
+        response
+      end
+
+      def rest_client(kind, rest_parameter, &block)
+        url = rest_parameter.url(host_uri(kind), @force_path_style)
+
+        rest_parameter.headers.merge!({
+          Authorization: rest_parameter.authentication(@access_key_id, @secret_access_key, @force_path_style),
+          Date: rest_parameter.calc_date,
+          Host: host_name(kind, rest_parameter.bucket),
+          Accept: '*/*; q=0.5, application/xml',
+          'Accept-Encoding' => 'gzip, deflate',
+          'User-Agent' => "s3-client (#{S3::VERSION})"
+        })
+
+        parameters = rest_parameter.parameters
+
+        unless rest_parameter.headers['Content-Type']
+          if rest_parameter.content_type
+            rest_parameter.headers.merge!(
+                'Content-Type' => rest_parameter.content_type
+            )
+          end
+        end
+
+        payload = if parameters.present? || rest_parameter.blank_body?
+                    parameters
+                  elsif block_given?
+                    block.call
+                  end
+
+        unless rest_parameter.headers['Content-Length']
+          rest_parameter.headers.merge!(
+              'Content-Length' => payload ? payload.size.to_s : 0.to_s
+          )
+        end
+
+        STDERR.print "\n" if @debug
+
+        headers = rest_parameter.headers
+        case rest_parameter.method
+          when :get
+            @http_client.get(url, nil, headers)
+
+          when :post
+            @http_client.post(url, payload, headers)
+
+          when :put
+            @http_client.put(url, payload, headers)
+
+          when :delete
+            @http_client.delete(url, nil, headers)
+
+        end
+      end
+
+      def host_name(kind, bucket)
+        uri = host_uri(kind)
+        result = uri.host
+
+        if kind == :storage
+          return result if valid_ip?(result)
+
+          if !@force_path_style && bucket.present?
+            result = "#{bucket}.#{result}"
+          end
+        end
+
+        unless uri.port == 80 || uri.port == 443
+          result += ":#{uri.port}"
+        end
+
+        result
+      end
+
+      def valid_ip?(str)
+        begin
+          IPAddr.new(str)
+          true
+        rescue
+          false
+        end
+      end
+
+      def host_uri(kind)
+        host_url = case kind
+                     when :storage
+                       @endpoint
+                   end
+
+        raise 'illegal kind' if host_url.blank?
+
+        URI.parse(host_url)
+      end
+
+    end
+  end
+end