sitemap_generator-aws_s3_adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bc3c4eb3425df85949f86d957fc1af4089370da
+  data.tar.gz: 6a41685acc748f5fdf05a8b4d2eb999b45c65134
+SHA512:
+  metadata.gz: d322431870e5b7fd9be31d95335ed441f7e93bcd8204c9772080b75de76bbb934dd7a49bc898896c9df5e0ba147dae6e1b8ac53ec7a7b946220918259f772f55
+  data.tar.gz: 3f86b36cb1376fa962b72cde591afb482ff2b152168cb9b0bfeb1133e00722dc6c54e4f04f4d7802361d267e3b520de42a19db88f1cb292006f9d8915e011156

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at junyaogura@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sitemap_generator-aws_s3_adapter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Junya Ogura and qnyp, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# SitemapGenerator::AwsS3Adapter
+
+[![Circle CI](https://circleci.com/gh/qnyp/sitemap_generator-aws_s3_adapter.svg?style=svg)](https://circleci.com/gh/qnyp/sitemap_generator-aws_s3_adapter)
+
+This is a yet another AWS S3 adapter for [sitemap_generator](https://github.com/kjvarga/sitemap_generator), built with official [aws-sdk](https://rubygems.org/gems/aws-sdk) v2.
+
+## Motivation
+
+fog introduces [bunch of runtime dependencies](https://rubygems.org/gems/fog). :weary:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sitemap_generator-aws_s3_adapter'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+## Usage
+
+Add following lines to your app's `config/sitemap.rb`.
+
+```ruby
+SitemapGenerator::Sitemap.adapter = SitemapGenerator::AwsS3Adapter.new(
+  access_key_id: '...',
+  secret_access_key: '...',
+  region: '...',
+  bucket_name: '...'
+)
+```
+
+If the specified bucket doesn't exist, it will create in the region automatically.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec sitemap_generator-aws_s3_adapter` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qnyp/sitemap_generator-aws_s3_adapter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sitemap_generator/aws_s3_adapter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path .bundle
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,5 @@
+machine:
+  timezone:
+    US/Pacific
+  ruby:
+    version: 2.3.0

data/lib/sitemap_generator/aws_s3_adapter.rb

@@ -0,0 +1,87 @@
+require 'sitemap_generator'
+
+begin
+  require 'aws-sdk'
+rescue LoadError
+  raise LoadError, "Missing required 'aws-sdk. Please 'gem install aws-sdk'."
+end
+
+module SitemapGenerator
+  # Adapter for S3 with aws-sdk gem.
+  class AwsS3Adapter
+    # Public: Initialize an instance.
+    #
+    # access_key_id     - An Access Key ID String.
+    # secret_access_key - A Secret Access Key String.
+    # bucket_name       - A bucket name String.
+    # region            - A region name String.
+    #
+    # Returns nothing.
+    def initialize(opts = {})
+      @access_key_id = opts[:access_key_id]
+      @secret_access_key = opts[:secret_access_key]
+      @bucket_name = opts[:bucket_name]
+      @region = opts[:region]
+    end
+
+    # Public: Writes a sitemap to S3 bucket.
+    #
+    # location - A SitemapGenerator::SitemapLocation object.
+    # raw_data - A raw data String.
+    #
+    # Returns nothing.
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+
+      create_bucket unless bucket_exists?
+      put_sitemap(location)
+    end
+
+    private
+
+    # Internal: Retuns S3 client object.
+    #
+    # Returns a Aws::S3::Client.
+    def s3_client
+      @s3_client ||= Aws::S3::Client.new(
+        access_key_id: @access_key_id,
+        secret_access_key: @secret_access_key,
+        region: @region
+      )
+    end
+
+    # Internal: Returns whether the target bucket does exist?
+    #
+    # Returns boolean.
+    def bucket_exists?
+      resp = s3_client.list_buckets
+      bucket = resp.buckets.find { |i| i.name == @bucket_name }
+      bucket != nil
+    end
+
+    # Internal: Creates a new bucket.
+    #
+    # Returns nothing.
+    def create_bucket
+      s3_client.create_bucket(acl: 'private', bucket: @bucket_name)
+    end
+
+    # Internal: Put a sitemap into the bucket.
+    #
+    # location - A SitemapGenerator::SitemapLocation object.
+    #
+    # Returns nothing.
+    def put_sitemap(location)
+      content_type = location[:compress] ? 'application/x-gzip' : 'application/xml'
+
+      s3_client.put_object(
+        acl: 'public-read',
+        body: File.open(location.path),
+        bucket: @bucket_name,
+        cache_control: 'private, max-age=0, no-cache',
+        content_type: content_type,
+        key: location.path_in_public
+      )
+    end
+  end
+end

data/lib/sitemap_generator/aws_s3_adapter/version.rb

@@ -0,0 +1,5 @@
+module SitemapGenerator
+  class AwsS3Adapter
+    VERSION = '0.1.0'.freeze
+  end
+end

data/sitemap_generator-aws_s3_adapter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitemap_generator/aws_s3_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sitemap_generator-aws_s3_adapter'
+  spec.version       = SitemapGenerator::AwsS3Adapter::VERSION
+  spec.authors       = ['Junya Ogura', 'qnyp, inc.']
+  spec.email         = ['junyaogura@gmail.com']
+
+  spec.summary       = %q(Yet another AWS S3 adapter for sitemap_generator gem.)
+  spec.description   = %q(Yet another AWS S3 adapter for sitemap_generator gem. This adapter works with official aws-sdk gem instead of fog.)
+  spec.homepage      = 'https://github.com/qnyp/sitemap_generator-aws_s3_adapter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'aws-sdk', '~> 2.2.0'
+  spec.add_runtime_dependency 'sitemap_generator', '~> 5.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sitemap_generator-aws_s3_adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Junya Ogura
+- qnyp, inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: sitemap_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Yet another AWS S3 adapter for sitemap_generator gem. This adapter works
+  with official aws-sdk gem instead of fog.
+email:
+- junyaogura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/sitemap_generator/aws_s3_adapter.rb
+- lib/sitemap_generator/aws_s3_adapter/version.rb
+- sitemap_generator-aws_s3_adapter.gemspec
+homepage: https://github.com/qnyp/sitemap_generator-aws_s3_adapter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Yet another AWS S3 adapter for sitemap_generator gem.
+test_files: []