headquarters 0.0.6 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43198a48f9901f5900852f1fd11848d440cb848f
-  data.tar.gz: d1209da04b09c6acb42870485cd19e4f1637d198
+  metadata.gz: 50c8858cd727bb5bfaa410338e9954e8aead57fb
+  data.tar.gz: 14be54a98af2d5aa54487e167ebaff35f8df1756
 SHA512:
-  metadata.gz: 1405d43de40c5690bddbfe98fb1cf31532e9befa2d037264eaa337500817309e4ba1681ff1cdeabe5f2877aaa50047eb1a1ad62ebcbc21d375f363a7672c5647
-  data.tar.gz: f99be3350fe0c937e6eae7dca86688bb7b5900412959af57fd08805f84fb0e00225e79c41bfee4a8bf4179883e04a1782f16df167d313cb26b74f81e801851a5
+  metadata.gz: 20688ff4596a0c475d428f8783358cae21a066bc87c50fc2f3c3de0120316ace93fee8830fe32afc02ebd9fcd98244ec2515ad347f0d4830563b4b9578b60a4a
+  data.tar.gz: 66fa2672ef7ddf33476e4533c7c1acf8af9044288f3a1415bf829a5096ec880fe48cef1d987ece4210a9e8a686168319c7e7dfa51e4960db71901cdce1489f77

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+.env

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in headquarters.gemspec
 gemspec
+
+gem 'pry'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Group Buddies
+Copyright (c) 2014-2015 Group Buddies
 
 MIT License
 

data/README.md

@@ -1,7 +1,8 @@
 # Headquarters
 
-Ruby wrapper for the [headquarters
-API](https://github.com/groupbuddies/headquarters)
+[![Build Status](https://semaphoreapp.com/api/v1/projects/2a53d14e-b72c-4047-bd1d-1193498cf8fe/311022/shields_badge.svg)](https://semaphoreapp.com/groupbuddies/headquarters-ruby)
+
+Ruby wrapper for the [headquarters API](https://github.com/groupbuddies/headquarters)
 
 ## Installation
 
@@ -11,6 +12,12 @@ Add this line to your application's Gemfile:
 gem 'headquarters'
 ```
 
+Or if you want the edge version:
+
+```ruby
+gem 'headquarters', github: 'groupbuddies/headquarters-ruby'
+```
+
 And then execute:
 
     $ bundle
@@ -19,9 +26,119 @@ Or install it yourself as:
 
     $ gem install headquarters
 
+
+## Configuration
+
+You can set the API's base endpoint and port:
+
+```ruby
+Headquarters.api_base = "0.0.0.0"
+Headquarters.api_port = 3000
+```
+
+### Logging
+
+Out of the box headquarters-ruby will log all requests and responses to `STDOUT`, you
+can use any logger you want, though:
+
+```ruby
+Headquarters.logger = Logger.new(STDERR)
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+These are all the available method to interact with the headquarters.
+
+### Members
+
+To retrieve a collection of all members of the team you might use the `all`
+operation:
+
+```ruby
+Headquarters::Member.all
+```
+
+Or you can search for a specific email
+
+```ruby
+Headquarters::Member.search('mpalhas@groupbuddies.com')
+```
+
+### Pull Requests
+
+To get all (paginated) pull requests for groupbuddies, use the
+`pull_requests` operation:
+
+```ruby
+Headquarters::Github.pull_requests
+```
+
+You can filter these results using anything that github takes in the `q`
+parameters of its [search API](https://developer.github.com/v3/search/). For
+instance, if you want to get only the open pull requests, you might do:
+
+```ruby
+Headquarters::Github.pull_requests(query: 'is:open')
+```
+
+### Internal
+
+There is some extra info protected with basic authentication. In order to get it
+you must first add the credentials to you `.env` file:
+
+```
+BASIC_AUTH_USER=some-username
+BASIC_AUTH_PASS=some-password
+```
+
+#### Members
+
+Now you may use the `all_internal` operation:
+
+```ruby
+Headquarters::Member.all_internal
+```
+
+#### Emails
+
+You can send emails for Group Buddies addresses (Any non-GB addresses will be filtered out).
+
+`app_name` can be set to be appended to the sender. i.e. `from: hq@groupbuddies.com, app_name: test` will become `hq+test@groupbuddies.com`. This is useful for filtering and labeling.
+
+```ruby
+Headquarters::Email.send(to: 'mpalhas@groupbuddies.com,zamith@groupbuddies.com', subject: 'custom subject', body: '<b>HTML body</b>', app_name: 'hq')
+```
+
+  When using rails you can use headquarters as the delivery method, and transparently send emails using ActiveMailer as usual:
+
+```ruby
+# config/initializers/mailer.rb
+ActionMailer::Base.delivery_method = :headquarters
+```
+
+Using this method, `app_name` is also available as a header or parameter to the `mail` function
+
+```ruby
+class CustomMailer < ActionMailer::Base
+  # option 1, default header
+  default 'app_name' => 'MyApp'
+
+  def email
+    # option 2, as an argument
+    mail to: 'example@email.com', subjet: 'Subject', app_name: 'MyApp'
+  end
+end
+```
+
+## Testing
+
+To run the tests (including style tests with Rubucop) install all the
+dependencies and run the default rake task:
+
+```
+bundle install
+bundle exec rake
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
+task default: [:rubocop, :spec]

data/headquarters.gemspec

@@ -4,22 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'headquarters/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "headquarters"
+  spec.name          = 'headquarters'
   spec.version       = Headquarters::VERSION
-  spec.authors       = ["Miguel Palhas", "Luís Ferreira"]
-  spec.email         = ["mpalhas@groupbuddies.com", "zamith@groupbuddies.com"]
+  spec.authors       = ['Miguel Palhas', 'Luís Ferreira']
+  spec.email         = ['mpalhas@groupbuddies.com', 'zamith@groupbuddies.com']
   spec.summary       = %q{Ruby wrapper for the headquarters API for Group Buddies}
   spec.description   = %q{Ruby wrapper for the headquarters API for Group Buddies}
-  spec.homepage      = "https://github.com/groupbuddies/headquarters-ruby"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/groupbuddies/headquarters-ruby'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'dotenv'
   spec.add_dependency 'httparty', '>= 0.13.3'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'climate_control'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.27.1'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'webmock', '~> 1.20.4'
 end

data/lib/headquarters/email/rails_delivery_method.rb

@@ -0,0 +1,30 @@
+require 'headquarters/email'
+
+module Headquarters
+  class Email
+    class RailsDeliveryMethod
+      attr_accessor :options
+
+      def initialize(options = {})
+        self.options = options
+      end
+
+      def deliver(mail)
+        params = {
+          from:     mail.from,
+          to:       mail.to,
+          subject:  mail.subject,
+          body:     mail.body.to_s,
+          app_name: mail.header['app_name'].to_s
+        }
+        Headquarters::Email.new(params).send
+      end
+
+      alias_method :deliver!,       :deliver
+      alias_method :deliver_now,    :deliver
+      alias_method :deliver_now!,   :deliver
+      alias_method :deliver_later,  :deliver
+      alias_method :deliver_later!, :deliver
+    end
+  end
+end

data/lib/headquarters/email.rb

@@ -0,0 +1,31 @@
+module Headquarters
+  class Email
+    FIELDS = %i(to from subject app_name body)
+
+    def self.send(**raw_params)
+      prepare_params(raw_params)
+      Request.perform_with_auth(:post, Endpoints::Internal::EMAIL, params)
+    end
+
+    class << self
+      attr_accessor(*FIELDS)
+    end
+
+    def self.params
+      Hash[FIELDS.map do |field|
+        [field, public_send(field)]
+      end.compact]
+    end
+
+    def self.prepare_params(raw_params)
+      @to = raw_params[:to]
+      if @to.is_a? Array
+        @to = @to.join(',')
+      end
+      @from = raw_params[:from]
+      @subject = raw_params[:subject]
+      @app_name = raw_params[:app_name]
+      @body = raw_params[:body]
+    end
+  end
+end

data/lib/headquarters/endpoints.rb

@@ -0,0 +1,14 @@
+module Headquarters
+  module Endpoints
+    MEMBERS = '/members'
+
+    module Github
+      PULL_REQUESTS = '/github/pull_requests'
+    end
+
+    module Internal
+      MEMBERS = '/internal/members'
+      EMAIL = '/internal/emails'
+    end
+  end
+end

data/lib/headquarters/github.rb

@@ -0,0 +1,7 @@
+module Headquarters
+  class Github
+    def self.pull_requests(query: nil)
+      Request.perform(:get, Endpoints::Github::PULL_REQUESTS, query: { q: query })
+    end
+  end
+end

data/lib/headquarters/member.rb

@@ -0,0 +1,15 @@
+module Headquarters
+  class Member
+    def self.all
+      Request.perform(:get, Endpoints::MEMBERS)
+    end
+
+    def self.search(query)
+      Request.perform(:get, Endpoints::MEMBERS, q: query)
+    end
+
+    def self.all_internal
+      Request.perform_with_auth(:get, Endpoints::Internal::MEMBERS)
+    end
+  end
+end

data/lib/headquarters/railtie.rb

@@ -0,0 +1,12 @@
+require 'headquarters/email'
+require 'headquarters/email/rails_delivery_method'
+
+module Headquarters
+  class Railtie < Rails::Railtie
+    initializer 'headquaters.add_delivery_method' do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :headquarters, Headquarters::Email::RailsDeliveryMethod
+      end
+    end
+  end
+end

data/lib/headquarters/request.rb

@@ -3,10 +3,71 @@ require 'httparty'
 module Headquarters
   class Request
     include ::HTTParty
-    base_uri 'hq.groupbuddies.com'
+    base_uri Headquarters.api_base
 
-    def self.get_json(path)
-      get(path).to_json
+    def self.perform_with_auth(http_method, path, params = {}, options = {})
+      options_with_auth = options.merge(basic_auth_info)
+      perform(http_method, path, params, options_with_auth)
+    end
+
+    def self.perform(http_method, path, params = {}, options = {})
+      new(path, params, options).public_send(http_method)
+    end
+
+    def initialize(path, params, options)
+      @path = path
+      @options = options
+      @params = params
+    end
+
+    def get
+      @options.merge!(query: params) if params && params.any?
+      response = Request.get(path, options)
+      log_request_info(:get, response)
+      response.parsed_response
+    end
+
+    def post
+      @options.merge!(body: params) if params && params.any?
+      response = Request.post(path, options)
+      log_request_info(:post, response)
+      response.parsed_response
+    end
+
+    private
+
+    attr_reader :path, :options, :params
+
+    def log_request_info(http_method, response)
+      Headquarters.logger.info "[HQ] [#{current_time}] #{http_method.to_s.upcase} #{path} #{options} #{response.code}"
+    end
+
+    def current_time
+      Time.now.utc.strftime('%d/%b/%Y %H:%M:%S %Z')
+    end
+
+    def self.basic_auth_info
+      hq_basic_auth_info || deprecated_basic_auth_info
+    end
+
+    def self.hq_basic_auth_info
+      return unless ENV['HQ_BASIC_AUTH_USER']
+      {
+        basic_auth: {
+          username: ENV['HQ_BASIC_AUTH_USER'],
+          password: ENV['HQ_BASIC_AUTH_PASS']
+        }
+      }
+    end
+
+    def self.deprecated_basic_auth_info
+      warn '[DEPRECATED] Using ENV["BASIC_AUTH_USER"] is deprecated. Please use ENV["HQ_BASIC_AUTH_USER"]'
+      {
+        basic_auth: {
+          username: ENV['BASIC_AUTH_USER'],
+          password: ENV['BASIC_AUTH_PASS']
+        }
+      }
     end
   end
 end

data/lib/headquarters/version.rb

@@ -1,3 +1,3 @@
 module Headquarters
-  VERSION = '0.0.6'
+  VERSION = '0.1.1'
 end

data/lib/headquarters.rb

@@ -1,6 +1,30 @@
+require 'net/https'
+require 'logger'
+require 'dotenv'
+
 require 'headquarters/version'
-require 'headquarters/request'
-require 'headquarters/members'
+require 'headquarters/endpoints'
+
+if defined? ::Rails::Railtie
+  require 'headquarters/railtie'
+end
 
 module Headquarters
+  API_BASE = 'hq.groupbuddies.com'
+  ROOT_PATH = File.dirname(__FILE__)
+
+  @api_base = API_BASE
+  @api_port = Net::HTTP.https_default_port
+  @logger   = Logger.new(STDOUT)
+
+  class << self
+    attr_accessor :api_base, :api_port, :logger
+  end
 end
+
+require 'headquarters/request'
+require 'headquarters/member'
+require 'headquarters/github'
+require 'headquarters/email'
+
+Dotenv.load

data/spec/email_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Headquarters
+  describe Email do
+    context '.send' do
+      it 'makes a new POST request using the correct API endpoint' do
+        allow(Request).to receive(:perform_with_auth)
+        params = { subject: 'fake subject' }
+
+        Email.send(params)
+
+        expect(Request).to have_received(:perform_with_auth).with(:post, Endpoints::Internal::EMAIL, hash_including(params))
+      end
+    end
+  end
+end

data/spec/github_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Headquarters
+  describe Github do
+    context '.pull_requests' do
+      it 'asks for all the pull requests' do
+        allow(Request).to receive(:perform)
+
+        Github.pull_requests
+
+        expect(Request).to have_received(:perform).
+          with(:get, Endpoints::Github::PULL_REQUESTS, query: { q: nil })
+      end
+
+      it 'asks for the open pull requests' do
+        allow(Request).to receive(:perform)
+
+        Github.pull_requests(query: 'is:open')
+
+        expect(Request).to have_received(:perform).
+          with(:get, Endpoints::Github::PULL_REQUESTS, query: { q: 'is:open' })
+      end
+    end
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Headquarters
+  describe Member do
+    context '.all' do
+      it 'makes a new GET request using the correct API endpoint' do
+        allow(Request).to receive(:perform)
+
+        Member.all
+
+        expect(Request).to have_received(:perform).with(:get, Endpoints::MEMBERS)
+      end
+    end
+
+    context '.all_internal' do
+      it 'makes a new GET request using the correct API endpoint' do
+        allow(Request).to receive(:perform_with_auth)
+
+        Member.all_internal
+
+        expect(Request).to have_received(:perform_with_auth).with(:get, Endpoints::Internal::MEMBERS)
+      end
+    end
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
+module Headquarters
+  describe Request do
+    let(:request) { spy('request') }
+
+    context '.perform' do
+      it 'makes the correct call for a GET' do
+        allow(Request).to receive(:new).and_return(request)
+
+        Request.perform(:get, '/some-url')
+
+        expect(request).to have_received(:get)
+      end
+
+      it 'makes the correct call for a POST' do
+        allow(Request).to receive(:new).and_return(request)
+
+        Request.perform(:post, '/some-url')
+
+        expect(request).to have_received(:post)
+      end
+
+      it 'makes the actual call' do
+        url = '/some-url'
+        stub_request(:get, Headquarters.api_base + url)
+        allow(Request).to receive(:get).and_call_original
+
+        Request.perform(:get, url)
+
+        expect(Request).to have_received(:get).with(url, {})
+      end
+    end
+
+    context '.perform_with_auth' do
+      it 'makes the actual call with basic auth' do
+        url = '/some-url'
+        credentials = { basic_auth: { username: 'user', password: 'pass' } }
+        new_env = {
+          BASIC_AUTH_PASS: credentials[:basic_auth][:password],
+          BASIC_AUTH_USER: credentials[:basic_auth][:username]
+        }
+        stub_request(:get, 'user:pass@' + Headquarters.api_base + url)
+        allow(Request).to receive(:get).and_call_original
+
+        with_modified_env new_env do
+          Request.perform_with_auth(:get, url)
+
+          expect(Request).to have_received(:get).with(url, credentials)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'headquarters'
+require 'climate_control'
+
+Dir[File.join(Headquarters::ROOT_PATH, 'spec/support/**/*.rb')].each { |f| require f }
+
+class DummyLogger
+  def self.info(_message); end
+end
+Headquarters.logger = DummyLogger
+
+def with_modified_env(options, &block)
+  ClimateControl.modify(options, &block)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: headquarters
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.1
 platform: ruby
 authors:
 - Miguel Palhas
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -26,19 +40,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.13.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +67,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
 description: Ruby wrapper for the headquarters API for Group Buddies
 email:
 - mpalhas@groupbuddies.com
@@ -62,15 +118,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - headquarters.gemspec
 - lib/headquarters.rb
-- lib/headquarters/members.rb
+- lib/headquarters/email.rb
+- lib/headquarters/email/rails_delivery_method.rb
+- lib/headquarters/endpoints.rb
+- lib/headquarters/github.rb
+- lib/headquarters/member.rb
+- lib/headquarters/railtie.rb
 - lib/headquarters/request.rb
 - lib/headquarters/version.rb
+- spec/email_spec.rb
+- spec/github_spec.rb
+- spec/member_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/groupbuddies/headquarters-ruby
 licenses:
 - MIT
@@ -91,8 +158,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the headquarters API for Group Buddies
-test_files: []
+test_files:
+- spec/email_spec.rb
+- spec/github_spec.rb
+- spec/member_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb

data/lib/headquarters/members.rb

@@ -1,7 +0,0 @@
-module Headquarters
-  class Members
-    def self.all
-      Request.get_json('/members')
-    end
-  end
-end