community-zero 1.0.0

data/lib/community_zero/errors/rest_error.rb

@@ -0,0 +1,30 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # A general error for failed communicate with a REST API.
+  #
+  # @author Seth Vargo <sethvargo@gmail.com>
+  class RestError < Error
+    attr_reader :response_code, :error
+
+    def initialize(response_code, error)
+      @response_code = response_code
+      @error = error
+    end
+  end
+end

data/lib/community_zero/object.rb

@@ -0,0 +1,25 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # The base class for objects.
+  #
+  # @author Seth Vargo <sethvargo@gmail.com>
+  class Object
+    require 'community_zero/objects/cookbook'
+  end
+end

data/lib/community_zero/objects/cookbook.rb

@@ -0,0 +1,99 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # An object representation of a cookbook.
+  #
+  # @author Seth Vargo <sethvargo@gmail.com>
+  class Cookbook
+    class << self
+      # Create a cookbook object from a hash.
+      #
+      # @param [Hash] hash
+      #   the hash from which to create the cookbook
+      def from_hash(hash)
+        new(hash)
+      end
+
+      # Create a cookbook object from a hash and commit that object
+      # to memory.
+      #
+      # @param [Hash] hash
+      #   the hash from which to create the cookbook
+      def create(hash)
+        new(hash).save
+      end
+    end
+
+    # Create a new cookbook from the given hash.
+    #
+    # @param [Hash] hash
+    #   the hash from which to create the cookbook
+    def initialize(hash = {})
+      @average_rating = 3
+      hash.each { |k,v| instance_variable_set(:"@#{k}",v) }
+    end
+
+    # Save this cookbook in the store.
+    def save
+      Store.update(self)
+    end
+
+    # Delete this cookbook from the store.
+    def destroy
+      Store.remove(self)
+    end
+
+    # A list of all other versions of this cookbook.
+    #
+    # @return [Array<String>]
+    #   the other verions
+    def versions
+      @versions ||= Store.versions(self)
+    end
+
+    # The latest (newest) version.
+    #
+    # @return [String]
+    #   the newest version
+    def latest_version
+      @latest_version ||= versions.last
+    end
+
+    # Dump this cookbook to a hash.
+    #
+    # @return [Hash]
+    #   the hash representation of this cookbook
+    def to_hash
+      methods = instance_variables.map { |i| i.to_s.gsub('@', '') }
+      Hash[*methods.map { |m| [m, send(m.to_sym)] }.flatten]
+    end
+
+    def method_missing(m, *args, &block)
+      if m.to_s =~ /\=$/
+        value = args.size == 1 ? args[0] : args
+        instance_variable_set(:"@#{m.to_s.gsub('=', '')}", value)
+      else
+        instance_variable_get(:"@#{m}")
+      end
+    end
+
+    def respond_to?(m, include_private = false)
+      instance_variables.map(&:to_s).include?("@#{m}")
+    end
+  end
+end

data/lib/community_zero/request.rb

@@ -0,0 +1,60 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # A singleton request.
+  #
+  # @author Seth Vargon <sethvargo@gmail.com>
+  class Request
+    attr_reader :env
+
+    def initialize(env)
+      @env = env
+    end
+
+    def base_uri
+      @base_uri ||= "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}"
+    end
+
+    def method
+      @env['REQUEST_METHOD']
+    end
+
+    def path
+      @path ||= env['PATH_INFO'].split('/').select { |part| part != "" }
+    end
+
+    def body=(body)
+      @body = body
+    end
+
+    def body
+      @body ||= env['rack.input'].read
+    end
+
+    def query_params
+      @query_params ||= begin
+        params = Rack::Request.new(env).GET
+        params.keys.each do |key|
+          params[key] = URI.unescape(params[key])
+        end
+        params
+      end
+    end
+  end
+end
+

data/lib/community_zero/router.rb

@@ -0,0 +1,55 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # The router for the Community Server.
+  #
+  # @author Seth Vargo <sethvargo@gmail.com>
+  class Router
+    require 'community_zero/endpoint'
+
+    attr_reader :server, :routes
+
+    def initialize(server, *routes)
+      @server = server
+      @routes = routes.map do |route, endpoint|
+        pattern = Regexp.new("^#{route.gsub(/:[A-Za-z_]+/, '[^/]*')}$")
+        [pattern, endpoint]
+      end
+    end
+
+    def call(request)
+      begin
+        path = '/' + request.path.join('/')
+        find_endpoint(path).new(server).call(request)
+      rescue
+        [
+          500,
+          { 'Content-Type' => 'text/plain' },
+          "Exception raised!  #{$!.inspect}\n#{$!.backtrace.join("\n")}"
+        ]
+      end
+    end
+
+    private
+      def find_endpoint(path)
+        _, endpoint = routes.find { |route, endpoint| route.match(path) }
+        endpoint || NotFoundEndpoint
+      end
+
+  end
+end

data/lib/community_zero/server.rb

@@ -0,0 +1,124 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # A single instance of the Community Server.
+  #
+  # @author Seth Vargo <sethvargo@gmail.com>
+  class Server
+    require 'community_zero'
+
+    DEFAULT_OPTIONS = {
+      :host => '0.0.0.0',
+      :port => 3000
+    }.freeze
+
+    # The list of options passed to the server.
+    #
+    # @return [Hash]
+    attr_reader :options
+
+    # Create a new Community site server.
+    #
+    # @param [Hash] options
+    #   a list of options to pass in
+    #
+    # @option options [String] :host
+    #   the host to listen on (default is 0.0.0.0)
+    # @option options [String, Fixnum] :port
+    #   the port to listen on (default is 3000)
+    def initialize(options = {})
+      @options  = DEFAULT_OPTIONS.merge(options)
+    end
+
+    # Start the community server.
+    #
+    # @return [Thread]
+    #   the thread the server is running in
+    def start
+      if options[:publish]
+        puts ">> Starting Community Zero (v#{CommunityZero::VERSION})..."
+        puts ">> Puma (v#{Puma::Const::PUMA_VERSION}) is listening at #{url}"
+        puts ">> Press CTRL+C to stop"
+      end
+
+      begin
+        thread = server.run.join
+      rescue Object, Interrupt
+        puts "\n>> Stopping Puma..." if options[:publish]
+        server.stop(true) if running?
+      end
+    end
+
+    # Determine if the server is currently running.
+    #
+    # @return [Boolean]
+    #   true if the server is currently running, false otherwise
+    def running?
+      server && server.running?
+    end
+
+    # Returns the URL the server is listening on.
+    #
+    # @example
+    #   server = CommunityZero.new
+    #   server.url #=> http://0.0.0.0:3000
+    #
+    # @example
+    #   server = CommunityZero.new(host: 'example.com', port: 80)
+    #   server.url #=> http://example.com:80
+    def url
+      @url ||= "http://#{options[:host]}:#{options[:port]}"
+    end
+
+    private
+      # The Community Zero server.
+      #
+      # @return [Puma::Server]
+      #   the actual server object
+      def server
+        return @server if @server
+
+        @server = Puma::Server.new(app, Puma::Events.new(STDERR, STDOUT))
+        @server.add_tcp_listener(options[:host], options[:port])
+        @server
+      end
+
+      # The actual application the server will respond to.
+      #
+      # @return []
+      def app
+        lambda do |env|
+          request = Request.new(env)
+          response = router.call(request)
+
+          response[-1] = Array(response[-1])
+          response
+        end
+      end
+
+      def router
+        @router ||= Router.new(self,
+          ['/search',                               SearchEndpoint],
+          ['/cookbooks',                            CookbooksEndpoint],
+          ['/cookbooks/:name',                      CookbookEndpoint],
+          ['/cookbooks/:name/versions/:version',    CookbookVersionsVersionEndpoint],
+        )
+      end
+
+  end
+end

data/lib/community_zero/store.rb

@@ -0,0 +1,149 @@
+#
+# Copyright 2013, Seth Vargo <sethvargo@gmail.com>
+# Copyright 2013, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CommunityZero
+  # @author Seth Vargo <sethvargo@gmail.com>
+  module Store
+    extend self
+
+    # The number of cookbooks in the store.
+    #
+    # @return [Fixnum]
+    #   the number of cookbooks in the store
+    def size
+      _cookbooks.keys.size
+    end
+
+    # The full array of cookbooks.
+    #
+    # @example
+    #   [
+    #     #<CommunityZero::Cookbook apache2>,
+    #     #<CommunityZero::Cookbook apt>
+    #   ]
+    #
+    # @return [Array<CommunityZero::Cookbook>]
+    #   the list of cookbooks
+    def cookbooks
+      _cookbooks.map { |_,v| v[v.keys.first] }
+    end
+
+    # Query the installed cookbooks, returning those who's name matches the
+    # given query.
+    #
+    # @param [String] query
+    #   the query parameter
+    #
+    # @return [Array<CommunityZero::Cookbook>]
+    #   the list of cookbooks that match the given query
+    def search(query)
+      regex = Regexp.new(query, 'i')
+      _cookbooks.collect do |_, v|
+        v[v.keys.first] if regex.match(v[v.keys.first].name)
+      end.compact
+    end
+
+    # Delete all cookbooks in the store.
+    def destroy_all
+      @_cookbooks = nil
+    end
+
+    # Add the given cookbook to the cookbook store. This method's
+    # implementation prohibits duplicate cookbooks from entering the store.
+    #
+    # @param [CommunityZero::Cookbook] cookbook
+    #   the cookbook to add
+    def add(cookbook)
+      cookbook = cookbook.dup
+      cookbook.created_at = Time.now
+      cookbook.updated_at = Time.now
+
+      entry = _cookbooks[cookbook.name] ||= {}
+      entry[cookbook.version] = cookbook
+    end
+    alias_method :update, :add
+
+    # Remove the cookbook from the store.
+    #
+    # @param [CommunityZero::Cookbook] cookbook
+    #   the cookbook to remove
+    def remove(cookbook)
+      return unless has_cookbook?(cookbook.name, cookbook.version)
+      _cookbooks[cookbook.name].delete(cookbook.version)
+    end
+
+    # Determine if the cookbook store contains a cookbook.
+    #
+    # @see {find} for the method signature and parameters
+    def has_cookbook?(name, version = nil)
+      !find(name, version).nil?
+    end
+
+    # Determine if the cookbook store contains a cookbook. If the version
+    # attribute is nil, this method will return the latest cookbook version by
+    # that name that exists. If the version is specified, this method will only
+    # return that specific version, or nil if that cookbook at that version
+    # exists.
+    #
+    # @param [String] name
+    #   the name of the cookbook to find
+    # @param [String, nil] version
+    #   the version of the cookbook to search
+    #
+    # @return [CommunityZero::Cookbook, nil]
+    #   the cookbook in the store, or nil if one does not exist
+    def find(name, version = nil)
+      possibles = _cookbooks[name]
+      return nil if possibles.nil?
+
+      version ||= possibles.keys.sort.last
+      possibles[version]
+    end
+
+    # Return a list of all versions for the given cookbook.
+    #
+    # @param [String, CommunityZero::Cookbook] name
+    #   the cookbook or name of the cookbook to get versions for
+    def versions(name)
+      name = name.respond_to?(:name) ? name.name : name
+      (_cookbooks[name] && _cookbooks[name].keys.sort) || []
+    end
+
+    private
+      # All the cookbooks in the store.
+      #
+      # @example
+      #   {
+      #     'apache2' => {
+      #       '1.0.0' => {
+      #         'license' => 'Apache 2.0',
+      #         'version' => '1.0.0',
+      #         'tarball_file_size' => 20949,
+      #         'file' => 'http://s3.amazonaws.com...',
+      #         'cookbook' => 'http://localhost:4000/apache2',
+      #         'average_rating' => nil
+      #       }
+      #     }
+      #   }
+      #
+      # @return [Hash<String, Hash<String, CommunityZero::Cookbook>>]
+      def _cookbooks
+        @_cookbooks ||= {}
+      end
+
+  end
+end