s3_tree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81d145838e84b58f987d83cc6c81d935fb490063
+  data.tar.gz: 5e0c67498689c33ebb9a7c88d68441be529d258b
+SHA512:
+  metadata.gz: 5d85b3ee763069cd275e83a4cd977d74ee87c8c217c295612bc51e4741166fc3ebaee37212c242f910ace83e7ae5cc0b63e2428392bebfabf33b0a6c3afdc43c
+  data.tar.gz: 128dbf471a9acf3410aaaebeaab7122e15f4256dd0a8d7e580211c01b891bebaf9f0882853b96c8b078a712debc6ad85c3925dbed82e968f58f47faabd7081b6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in s3_tree.gemspec
+gemspec
+
+gem 'aws-sdk', '~> 2'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,135 @@
+# S3Tree
+
+This gem use to create tree structure or listing of AWS S3 files and directories. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3_tree
+## Requirements
+```ruby
+ gem 'aws-sdk', '~> 2'
+ ```
+ 
+ Currently this gem support only 'aws-sdk' version 2. See documentation for [aws-sdk-ruby](https://github.com/aws/aws-sdk-ruby).
+## Syntax
+```ruby
+     S3Tree.tree(bucket_object,path_to_directory)
+ ```
+ Leave `path` option blank for get all listing 
+## Usage
+```ruby
+require 's3_tree'
+  
+class ReportsController < ApplicationController
+  def index
+    s3 = Aws::S3::Resource.new
+    bucket = s3.bucket('g8way-files')
+    @tree = S3Tree.tree(bucket,'')
+  end
+end
+ ```
+ `index.html.erb`
+ ```html
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Last Modified</th>
+        <th>Size</th>
+      </tr>
+    </thead>
+    <tbody>
+    <% @tree.each do |node| %>
+        <tr>
+          <td>
+            <% if (node.class == S3Tree::File) %>
+              <%= link_to  node.name, node.url %>
+            <% else %>
+              <%= link_to node.name, reports_path(path: node.path)%>
+            <% end %>
+          </td>
+          <td width="25%">
+            <%= node.last_modified %>
+          </td>
+          <td width="15%">
+            <%= node.size %>
+          </td>
+        </tr>
+      </tbody>
+      <% end %>
+    <% end %>
+  </table>
+
+ ```
+## Useful methods
+
+`Directory Methods`
+> name
+
+ It will return name of directory.
+  
+> parent
+   
+ It will return parent directory if exist.
+
+> subdirectories
+   
+ It will return subdirectory of current directory.
+    
+> files
+ 
+ It will return all files of current directory.
+    
+> children   
+    
+ It will return subdirectory and files combination of current directory.
+   
+> size
+   
+ It will return size of directory.
+   
+> last_modified
+   
+ Last modification date of directory.  
+ 
+`File Methods` 
+
+> name
+
+ It will return name of file.
+  
+> extension
+   
+ It will return extension of file.
+
+> directory
+   
+ It will return container directory.
+    
+> s3_object
+ 
+ It will return original s3 object for direct use.
+      
+> size
+   
+ It will return size of directory.
+   
+> last_modified
+   
+ Last modification date of directory.
+ 
+> url
+ 
+ It will return presigned url for one click download file.

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 "s3_tree"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/s3_tree/version.rb

@@ -0,0 +1,3 @@
+module S3Tree
+  VERSION = "0.0.1"
+end

data/lib/s3_tree.rb

@@ -0,0 +1,44 @@
+require 's3_tree/version'
+require 's3_tree/directory'
+require 's3_tree/file'
+
+module S3Tree
+  def self.tree(bucket_name,path='')
+    path = path + '/' if path.present?
+    s3 = Aws::S3::Resource.new
+    bucket = s3.bucket(bucket_name)
+    S3Tree::Directory.new(bucket,path).children
+  end
+
+  # def self.list(bucket_name,path='')
+  #   tree = {}
+  #   path = path + '/' if path.present?
+  #   s3 = Aws::S3::Resource.new
+  #   bucket = s3.bucket(bucket_name)
+  #   objects = bucket.objects.collect(&:key)
+  #   objects.each do |object|
+  #     length = object.length
+  #     array = object.split('/')
+  #     value = array.pop
+  #     directories = S3Tree::Directory.new(bucket,path).children if array[length - 1] == '/'
+  #     h = array.reverse.inject(value) { |a, n| { n => a } }
+  #   end
+  #
+  # end
+  #
+  # private
+  #
+  # def generate_tree(bucket,path='')
+  #   directories = S3Tree::Directory.new(bucket,path).subdirectories
+  #   directories.each do |directory|
+  #
+  #     #
+  #     #   tree[directory.name] = {}
+  #     #   directories = S3Tree::Directory.new(bucket,URI.decode(directory.path).gsub('+', ' '))
+  #     # else
+  #     #   tree[directory.directory.name] = S3Tree::Directory.new(bucket,directory.name + '/').files
+  #     # end
+  #   end
+  # end
+
+end

data/s3_tree.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "s3_tree/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_tree"
+  spec.version       = S3Tree::VERSION
+  spec.authors       = ["Hardik Upadhyay"]
+  spec.email         = ["hardik.upadhyay1992@gmail.com"]
+
+  spec.summary       = %q{s3 bucket listing}
+  spec.description   = %q{Represent your S3 bucket directory or file in tree view. }
+  spec.homepage      = "http://rubygems.org/gems/s3_tree"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org/'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: s3_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hardik Upadhyay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 'Represent your S3 bucket directory or file in tree view. '
+email:
+- hardik.upadhyay1992@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/s3_tree.rb
+- lib/s3_tree/version.rb
+- s3_tree.gemspec
+homepage: http://rubygems.org/gems/s3_tree
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.6.8
+signing_key: 
+specification_version: 4
+summary: s3 bucket listing
+test_files: []