net-imap-proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 105b3fd8365f4604a8c7c75d577df63eb932e26d34a39e1502ba3be05da4cf2e
+  data.tar.gz: 7b470cfe39c43b82f3e2439338e75136bf509a61f53f4aca2275ee96b6efca0e
+SHA512:
+  metadata.gz: 5a0e1a176e95c0feffd7df9d169d46bfa407cd4ac5fe9121daa6fb7731ba50760bb00c52c67de30b62c8386c3d219b144115c07cdde0b9b0c5b521a886610a73
+  data.tar.gz: 828242beb88179d595fb2cd6376b5b335dfa01e58062c5926103de2d6cf46d26cf5457cb938281e01bf0492839b728064631ff13a335dc3b8fc4b40d83d6dcf5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

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 sebastian.johnsson@gmail.com. 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"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in net-imap-proxy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    net-imap-proxy (0.1.0)
+      proxifier (~> 1.0, >= 1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.2)
+    proxifier (1.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  mail (~> 2.7, >= 2.7.1)
+  net-imap-proxy!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sebastian Johnsson
+
+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,72 @@
+# Net::IMAP::Proxy
+
+Proxy support for Ruby's NET::IMAP library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-imap-proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-imap-proxy
+
+## Usage
+
+The recommended way to use this gem is to use the [Mail gem](https://github.com/mikel/mail) and the provided [retriever method](lib/net/imap/proxy/retriever_method.rb):
+
+```ruby
+Mail.defaults do                      
+  retriever_method ::Net::IMAP::Proxy::RetrieverMethod,
+    address:       'imap.gmail.com',
+    port:          993,
+    user_name:     'username@gmail.com',
+    password:      'somePassw0rd',
+    enable_ssl:    true,
+    proxy_address: 'http://proxy.domain.com',
+    proxy_port:    8080
+end
+
+Mail.find(mailbox: "Inbox", order: :desc, count: :all)&.each do |email|
+  puts "From: #{email.from&.first&.strip}. Subject: #{email.subject}"
+end
+```
+
+If you want to use the gem without the [Mail gem](https://github.com/mikel/mail), instantiate an instance of the `Proxy` class and use it to make IMAP requests:
+
+```ruby
+address         =   'imap.gmail.com'
+port            =   993
+proxy_address   =   'http://proxy.domain.com' # Authentication is also supported, e.g. http://user:password@proxy.domain.com
+proxy_port      =   8080
+
+proxy           =   Net::IMAP::Proxy.new(address, port, proxy_address, proxy_port, true, nil, false) # true, nil, false = enable ssl, without specifying certs and disable ssl verification
+proxy.login('username@gmail.com', 'somePassw0rd')
+proxy.select("INBOX")
+pp proxy.search(["ALL"])
+```
+
+## 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.
+
+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/SebastianJ/net-imap-proxy. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Net::IMAP::Proxy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/net-imap-proxy/blob/master/CODE_OF_CONDUCT.md).

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 "net/imap/proxy"
+
+# 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/net/imap/proxy.rb

@@ -0,0 +1,24 @@
+require 'net/imap'
+require 'proxifier'
+
+module Net
+  class IMAP
+    class Proxy < IMAP
+      autoload :RetrieverMethod, 'net/imap/proxy/retriever_method'
+
+      attr_reader :proxy_address, :proxy_port
+
+      def initialize(address, port, proxy_address = nil, proxy_port = nil, use_ssl = false, certs = nil, verify = false)
+        @proxy_address  =   proxy_address
+        @proxy_port     =   proxy_port
+        
+        super(address, port, use_ssl, certs, verify)
+      end
+
+      private
+        def tcp_socket(address, port)
+          Proxifier::Proxy("#{proxy_address}:#{proxy_port}").open(address, port)
+        end
+    end
+  end
+end

data/lib/net/imap/proxy/retriever_method.rb

@@ -0,0 +1,52 @@
+require 'net/imap'
+
+begin
+  require 'mail'
+rescue LoadError
+  puts 'The mail gem is required to use the DeliveryMethod class.'
+end
+
+module Net
+  class IMAP
+    class Proxy < IMAP
+      # for use with the mail gem
+      class RetrieverMethod < ::Mail::IMAP
+        private
+        
+        # adapted from
+        # https://github.com/mikel/mail/blob/master/lib/mail/network/retriever_methods/imap.rb#L160
+        def start(config=Mail::Configuration.instance, &block)
+          raise ArgumentError.new("Mail::Retrievable#imap_start takes a block") unless block_given?
+
+          if settings[:enable_starttls] && settings[:enable_ssl]
+            raise ArgumentError, ":enable_starttls and :enable_ssl are mutually exclusive. Set :enable_ssl if you're on an IMAPS connection. Set :enable_starttls if you're on an IMAP connection and using STARTTLS for secure TLS upgrade."
+          end
+          
+          init_params = [
+            settings[:address], settings[:port],
+            settings[:proxy_address], settings[:proxy_port],
+            settings[:enable_ssl], nil, false
+          ]
+
+          imap = Net::IMAP::Proxy.new(*init_params)
+          imap.starttls if settings[:enable_starttls]
+
+          if settings[:authentication].nil?
+            imap.login(settings[:user_name], settings[:password])
+          else
+            # Note that Net::IMAP#authenticate('LOGIN', ...) is not equal with Net::IMAP#login(...)!
+            # (see also http://www.ensta.fr/~diam/ruby/online/ruby-doc-stdlib/libdoc/net/imap/rdoc/classes/Net/IMAP.html#M000718)
+            imap.authenticate(settings[:authentication], settings[:user_name], settings[:password])
+          end
+
+          yield imap
+        ensure
+          if defined?(imap) && imap && !imap.disconnected?
+            imap.disconnect
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/net/imap/proxy/version.rb

@@ -0,0 +1,9 @@
+require 'net/imap'
+
+module Net
+  class IMAP
+    class Proxy < IMAP
+      VERSION = "0.1.0"
+    end
+  end
+end

data/net-imap-proxy.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "net/imap/proxy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-imap-proxy"
+  spec.version       = Net::IMAP::Proxy::VERSION
+  spec.authors       = ["Sebastian Johnsson"]
+  spec.email         = ["sebastian.johnsson@gmail.com"]
+
+  spec.summary       = %q{Proxy support for Ruby's Net::IMAP library.}
+  spec.description   = %q{Proxy support for Ruby's Net::IMAP library.}
+  spec.homepage      = "https://github.com/SebastianJ/net-imap-proxy"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'proxifier', '~> 1.0', '>= 1.0.3'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.add_development_dependency 'mail', '~> 2.7', '>= 2.7.1'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: net-imap-proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Johnsson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: proxifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+description: Proxy support for Ruby's Net::IMAP library.
+email:
+- sebastian.johnsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net/imap/proxy.rb
+- lib/net/imap/proxy/retriever_method.rb
+- lib/net/imap/proxy/version.rb
+- net-imap-proxy.gemspec
+homepage: https://github.com/SebastianJ/net-imap-proxy
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Proxy support for Ruby's Net::IMAP library.
+test_files: []