squad_goals 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: badf3262d4bdba40aa294a1ae0cda649102b0fe6
-  data.tar.gz: 7e2cfbed9d2db0c1219ddb3de19af209c73a551b
+  metadata.gz: 6c1fb894c8cc2a6c5f8978956a1d3ede6103cc06
+  data.tar.gz: 2aae2171c1243176dbeb2792d916088aaca9346c
 SHA512:
-  metadata.gz: f62dda1d8c8ef67640109fc358f4aa5d2b0924b1f59b7fef3e572412999224546f1a2b08ca3cfa1eef590747df241fad2239d1fb83d797f00cb1e949d9f8f80f
-  data.tar.gz: e756632cbc6fd58e1cc78cafca106a1180a674e398919ed90b6a0f921fe2cb0ca874e1b7e8bb37e3f780456d2f2270ee5001d3a5ee51976e1d23b3d4f1469878
+  metadata.gz: 7ccdb93391b1c71fab8eb744a242fd5034759f71522424cc620e3ea4bc409efb26a29a0bb1191c5182dcf65da8fda8142c5c8067aee802ed0fc3bd5b360e0fe1
+  data.tar.gz: 97f49c730d0387c4cf30bc0f1274917240fec2c4d204fef28c342a7c40454641c86bbb6ee659c699d200d474ecf6f94707f2f153372af3acfdda4bfdca0a513d

data/.gitignore

@@ -1,7 +1,6 @@
 .env
 .bundle
 *.gem
-Gemfile.lock
 /lib/squad_goals/public/vendor/jquery
 /lib/squad_goals/public/vendor/bootstrap/grunt
 /lib/squad_goals/public/vendor/bootstrap/js

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    squad_goals (0.1.0)
+      dalli (~> 2.7)
+      dotenv (~> 2.0)
+      octokit (~> 4.0)
+      rack-ssl-enforcer (~> 0.2)
+      sinatra_auth_github (~> 1.1)
+      warden-github (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    ast (2.2.0)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    dalli (2.7.6)
+    diff-lcs (1.2.5)
+    dotenv (2.1.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.8.4)
+    multipart-post (2.0.0)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-ssl-enforcer (0.2.9)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    safe_yaml (1.0.4)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
+      faraday (~> 0.8, < 0.10)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra_auth_github (1.2.0)
+      sinatra (~> 1.0)
+      warden-github (~> 1.2.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tilt (2.0.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (0.3.1)
+    warden (1.2.6)
+      rack (>= 1.0)
+    warden-github (1.2.0)
+      activesupport (> 3.0)
+      octokit (> 2.1.0)
+      warden (> 1.0)
+    webmock (1.24.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  pry (~> 0.10)
+  rack-test (~> 0.6)
+  rake (~> 10.0)
+  rspec (~> 3.1)
+  rubocop (~> 0.37)
+  squad_goals!
+  webmock (~> 1.2)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -51,6 +51,10 @@ The following environmental values should be set:
 * `GITHUB_TOKEN` - A personal access token for a user with admin rights to the organization
 * `GITHUB_TEAMS` - Comma-separated list of team names you'd like to allow access to, e.g, `red-team,blue-team`
 
+### Memcache
+
+You'll also need an instance of Memecache running, to cache API calls. If using Herkou, this can be within [memcachier's free use tier](https://devcenter.heroku.com/articles/memcachier).
+
 ### Customizing Views
 
 There are three views, `success`, `forbidden`, and `error`. They're pretty boring by default, so you may want to swap them out for something a bit my snazzy. If you had a views directory along side your `config.ru`, you can do so like this in your `config.ru` file:

data/lib/squad_goals.rb

@@ -3,39 +3,31 @@ require 'octokit'
 require 'dotenv'
 require 'yaml'
 require 'tilt/erb'
-
+require 'dalli'
+require 'digest'
 require 'squad_goals/version'
-require 'squad_goals/helpers'
-require 'squad_goals/app'
 
 module SquadGoals
-  def self.root
-    File.expand_path './squad_goals', File.dirname(__FILE__)
-  end
+  autoload :Helpers,      'squad_goals/helpers'
+  autoload :App,          'squad_goals/app'
+  autoload :Team,         'squad_goals/team'
+  autoload :Organization, 'squad_goals/organization'
 
-  def self.views_dir
-    @views_dir ||= File.expand_path 'views', SquadGoals.root
-  end
+  class << self
+    def root
+      File.expand_path './squad_goals', File.dirname(__FILE__)
+    end
 
-  def self.views_dir=(dir)
-    @views_dir = dir
-  end
+    def views_dir
+      @views_dir ||= File.expand_path 'views', SquadGoals.root
+    end
 
-  def self.public_dir
-    @public_dir ||= File.expand_path 'public', SquadGoals.root
-  end
+    attr_writer :views_dir
 
-  def self.public_dir=(dir)
-    @public_dir = dir
-  end
-end
+    def public_dir
+      @public_dir ||= File.expand_path 'public', SquadGoals.root
+    end
 
-unless SquadGoals::App.production?
-  Dotenv.load
-  stack = Faraday::RackBuilder.new do |builder|
-    builder.response :logger
-    builder.use Octokit::Response::RaiseError
-    builder.adapter Faraday.default_adapter
+    attr_writer :public_dir
   end
-  Octokit.middleware = stack
 end

data/lib/squad_goals/app.rb

@@ -1,9 +1,9 @@
 module SquadGoals
   class App < Sinatra::Base
-    include SquadGoals::Helpers
-
     set :github_options, scopes: ''
 
+    MEMCACHE_TTL = 60 * 5 # TTL for caching team info, in seconds
+
     use Rack::Session::Cookie, http_only: true,
                                secret: ENV['SESSION_SECRET'] || SecureRandom.hex
 
@@ -20,20 +20,61 @@ module SquadGoals
       use Rack::SslEnforcer
     end
 
+    configure :development do
+      Dotenv.load
+      Octokit.middleware = Faraday::RackBuilder.new do |builder|
+        builder.response :logger
+        builder.use Octokit::Response::RaiseError
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    configure do
+      set :organization, Organization.new(ENV['GITHUB_ORG_ID'])
+      set :client, Octokit::Client.new(access_token: ENV['GITHUB_TOKEN'])
+      set :dalli, Dalli::Client.new((ENV['MEMCACHIER_SERVERS'] || 'localhost:11211').split(','),
+                                    username: ENV['MEMCACHIER_USERNAME'],
+                                    password: ENV['MEMCACHIER_PASSWORD'],
+                                    failover: true,
+                                    socket_timeout: 1.5,
+                                    socket_failure_delay: 0.2,
+                                    exires_in: MEMCACHE_TTL)
+    end
+
+    def team_requested
+      settings.organization.teams.find { |team| team.slug == params['team'] }
+    end
+
+    helpers do
+      def avatar(user)
+        "<img class=\"avatar avatar-small\" src=\"https://github.com/#{user}.png\" alt=\"user\" width=\"20\" height=\"20\">"
+      end
+    end
+
+    def locals
+      {
+        organization: settings.organization,
+        teams: settings.organization.teams,
+        org_id: settings.organization.login,
+        team_requested: team_requested,
+        user: (github_user.login if github_user)
+      }
+    end
+
     get '/' do
-      erb :index, locals: { teams: teams, org_id: org_id }
+      erb :index, locals: locals
     end
 
     get '/join/:team' do
-      if team.nil? # invalid team
+      if team_requested.nil? # invalid team
         status 409
         halt erb :error
       end
 
       authenticate!
-      add!
+      team_requested.add(github_user.login)
 
-      erb :success, locals: { team: team, org_id: org_id }
+      erb :success, locals: locals
     end
   end
 end

data/lib/squad_goals/helpers.rb

@@ -1,33 +1,27 @@
 module SquadGoals
   module Helpers
-
-    def teams
-      @teams ||= begin
-        teams = client.organization_teams(org_id)
-        teams.select { |team| team_whitelist.include? team.slug }
-      end
+    # Call octokit, using memcached response, when available
+    def client_call(method, *args)
+      key = cache_key(method, args)
+      cached = dalli.get(key)
+      return cached if cached
+      response = client.send(method, *args)
+      dalli.set(key, response)
+      response
     end
 
     private
 
-    def team_whitelist
-      ENV['GITHUB_TEAMS'].split(",")
+    def cache_key(method, *args)
+      Digest::SHA1.hexdigest(method.to_s + ': ' + args.join(', '))
     end
 
     def client
-      @client ||= Octokit::Client.new access_token: ENV['GITHUB_TOKEN']
-    end
-
-    def org_id
-      ENV['GITHUB_ORG_ID']
-    end
-
-    def team
-      teams.find { |team| team.slug == params["team"] }
+      SquadGoals::App.client
     end
 
-    def add!
-      client.add_team_membership team.id, github_user.login
+    def dalli
+      SquadGoals::App.dalli
     end
   end
 end

data/lib/squad_goals/organization.rb

@@ -0,0 +1,31 @@
+module SquadGoals
+  class Organization
+    include SquadGoals::Helpers
+
+    attr_reader :login
+
+    def initialize(login)
+      @login = login.downcase.strip
+    end
+
+    def name
+      meta.name || "@#{meta.login}"
+    end
+
+    def teams
+      client_call(:organization_teams, login).map do |team|
+        Team.new(team)
+      end.select(&:whitelisted?)
+    end
+
+    def member?(user)
+      client_call :organization_member?, login, user
+    end
+
+    private
+
+    def meta
+      @meta ||= client_call :organization, login
+    end
+  end
+end

data/lib/squad_goals/team.rb

@@ -0,0 +1,38 @@
+module SquadGoals
+  class Team
+    include SquadGoals::Helpers
+
+    attr_reader :id, :name, :slug, :description
+
+    def initialize(hash)
+      @id = hash[:id]
+      @name = hash[:name]
+      @slug = hash[:slug]
+      @description = hash[:description]
+    end
+
+    def whitelisted?
+      Team.whitelist.include?(slug)
+    end
+
+    def members
+      client_call :team_members, id
+    end
+
+    def member?(user)
+      user && members.map { |u| u.login.downcase }.include?(user.downcase)
+    end
+
+    def add(user)
+      response = client_call :add_team_membership, id, user
+      dalli.flush
+      response
+    end
+
+    class << self
+      def whitelist
+        @whitelist ||= ENV['GITHUB_TEAMS'].split(',').map { |t| t.downcase.strip }
+      end
+    end
+  end
+end

data/lib/squad_goals/version.rb

@@ -1,3 +1,3 @@
 module SquadGoals
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/squad_goals/views/index.erb

@@ -1,8 +1,30 @@
-<h1></h1>
-
-<h2>@<%= org_id %>'s Teams</h2>
+<h2><%= organization.name %>'s Teams</h2>
 <% teams.each do |team| %>
   <h3><%= team.name %></h3>
   <p><%= team.description %></p>
-  <p><a class="btn" href="/join/<%= team.slug %>">Join @<%= org_id %>'s <%= team.name %></a></p>
+  <p>
+    <% if team.member?(user) %>
+    You're already a member of
+    <% else %>
+    <a class="btn" href="/join/<%= team.slug %>">Join
+      <% members = team.members.shuffle %>
+      <% if members.count != 0 %>
+        <% if members.count == 1 %>
+          <%= avatar members.first.login %>
+        <% elsif members.count == 2 %>
+          <%= avatar members[0].login %> and
+          <%= avatar members[1].login %>
+        <% elsif members.count == 3 %>
+          <%= avatar members[0].login %>,
+          <%= avatar members[1].login %>, and
+          <%= avatar members[2].login %>,
+        <% else %>
+          <%= avatar members[0].login %>,
+          <%= avatar members[1].login %>,
+          and <% members.count - 2 %> others
+        <% end %>
+        on
+      <% end %>
+    <% end %>
+    @<%= org_id %>'s <%= team.name %></a></p>
 <% end %>

data/lib/squad_goals/views/success.erb

@@ -1,9 +1,16 @@
 <h2>Success!</h2>
 
-<p>
-  You've successsfully joined @<%= org_id %>'s '<%= team.name %>.
-</p>
+<% if organization.member?(user) %>
+  <p>
+    You've successsfully joined <%= organization.name %>'s '<%= team_requested.name %>.
+  </p>
 
-<p>
-  <a href="/">Join another team?</a>
-</p>
+  <p>
+    <a href="/">Join another team?</a>
+  </p>
+<% else %>
+  <p>
+    Almost there. Just one more step.
+    Please <a href="https://github.com/orgs/<%= organization.login %>/invitation">accept this invitation</a> to join <%= organization.name %>, so that we can add you to the <%= team_requested.name %> team.
+  </p>
+<% end %>

data/squad_goals.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['ben.balter@github.com']
 
   spec.summary       = 'A tiny app to allow open-source contributors to opt-in to GitHub teams.'
-  spec.homepage      = "https://github.com/benbalter/squad_goals"
+  spec.homepage      = 'https://github.com/benbalter/squad_goals'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'octokit', '~> 4.0'
   spec.add_dependency 'rack-ssl-enforcer', '~> 0.2'
   spec.add_dependency 'dotenv', '~> 2.0'
+  spec.add_dependency 'dalli', '~> 2.7'
+
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rack-test', '~> 0.6'
   spec.add_development_dependency 'webmock', '~> 1.2 '

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squad_goals
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: warden-github
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +204,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -200,6 +215,7 @@ files:
 - lib/squad_goals.rb
 - lib/squad_goals/app.rb
 - lib/squad_goals/helpers.rb
+- lib/squad_goals/organization.rb
 - lib/squad_goals/public/vendor/bootstrap/.bower.json
 - lib/squad_goals/public/vendor/bootstrap/LICENSE
 - lib/squad_goals/public/vendor/bootstrap/bower.json
@@ -225,6 +241,7 @@ files:
 - lib/squad_goals/public/vendor/bootstrap/fonts/glyphicons-halflings-regular.woff
 - lib/squad_goals/public/vendor/bootstrap/fonts/glyphicons-halflings-regular.woff2
 - lib/squad_goals/public/vendor/bootstrap/package.json
+- lib/squad_goals/team.rb
 - lib/squad_goals/version.rb
 - lib/squad_goals/views/error.erb
 - lib/squad_goals/views/index.erb
@@ -254,8 +271,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: A tiny app to allow open-source contributors to opt-in to GitHub teams.
 test_files: []
+has_rdoc: