confyio 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea9e4413332fb7ad883b464c1a25cab29716df58
-  data.tar.gz: 391ffa974eba2de3d5245a46885918f0e06f6c41
+  metadata.gz: fa2dccd72c8a354d13cb76db736a3295a1fb0a33
+  data.tar.gz: 90319998a80cfd9fb81438dbcd83c899bc977231
 SHA512:
-  metadata.gz: d187682791f3ebf9bb4456ae708865c28e0b97352c4da5aac25eac12ff8c4abc664712c8e1629b96e11f37d0bce7ce6e70d8f83ee1f8f12bd5807011e066fe8b
-  data.tar.gz: 54ff76bd53bfa3801383fedb436107e0e3d0463d0945d7a41109f435df3e2dc85aa3d0c2d065eba0a0dfe7511b0e6ddba8ddd2ecc5023f771cb39a47391f7974
+  metadata.gz: e3470b9e5e4a876ec5e3be055ac4e3be1c0bea8a0da0eabb9857886d7604b1b61e8c219d38770db9493f28f9499d8b55a6888c828e3c881e245423f716e3d441
+  data.tar.gz: 59ec58a9370f41bdb24f65b2e8fe86503b5dd84dcebe0026ec0f1347c954ba4ff5a81f78d175da0c283e6784c5ec06ffaee1c9494e7d254a8eec1982b4e6c9a0

data/lib/confy/api/access.rb

@@ -0,0 +1,45 @@
+module Confy
+
+  module Api
+
+    # List of teams who has access to the project. Default team __Owners__ will have access to every project. Authenticated user should be the owner of the organization for the below endpoints.
+    #
+    # org - Name of the organization
+    # project - Name of the project
+    class Access
+
+      def initialize(org, project, client)
+        @org = org
+        @project = project
+        @client = client
+      end
+
+      # Give the team access to the given project. The __team__ in the request needs to be a string.
+      #
+      # '/orgs/:org/projects/:project/access' POST
+      #
+      # team - Name of the team
+      def add(team, options = {})
+        body = options.fetch(:body, {})
+        body[:team] = team
+
+        @client.post("/orgs/#{@org}/projects/#{@project}/access", body, options)
+      end
+
+      # Remove project access for the given team. The __team__ in the request needs to be a string. Can't delete default team's access.
+      #
+      # '/orgs/:org/projects/:project/access' DELETE
+      #
+      # team - Name of the team
+      def remove(team, options = {})
+        body = options.fetch(:body, {})
+        body[:team] = team
+
+        @client.delete("/orgs/#{@org}/projects/#{@project}/access", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/confy/api/config.rb

@@ -0,0 +1,41 @@
+module Confy
+
+  module Api
+
+    # Any member of the team which has access to the project can retrieve any of it's environment's configuration document or edit it.
+    #
+    # org - Name of the organization
+    # project - Name of the project
+    # env - Name of the environment
+    class Config
+
+      def initialize(org, project, env, client)
+        @org = org
+        @project = project
+        @env = env
+        @client = client
+      end
+
+      # Get an environment config of the project.
+      #
+      # '/orgs/:org/projects/:project/envs/:env/config' GET
+      def retrieve(options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/projects/#{@project}/envs/#{@env}/config", body, options)
+      end
+
+      # Update the configuration document for the given environment of the project. We will patch the document recursively.
+      #
+      # '/orgs/:org/projects/:project/envs/:env/config' POST
+      #
+      # body - Configuration to update
+      def update(body, options = {})
+        @client.post("/orgs/#{@org}/projects/#{@project}/envs/#{@env}/config", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/confy/api/envs.rb

@@ -0,0 +1,79 @@
+module Confy
+
+  module Api
+
+    # Every project has a default environment named Production. Each environment has one configuration document which can have many keys and values.
+    #
+    # org - Name of the organization
+    # project - Name of the project
+    class Envs
+
+      def initialize(org, project, client)
+        @org = org
+        @project = project
+        @client = client
+      end
+
+      # List all the environmens of the project which can be seen by the authenticated user.
+      #
+      # '/orgs/:org/projects/:project/envs' GET
+      def list(options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/projects/#{@project}/envs", body, options)
+      end
+
+      # Create an environment for the given project. Authenticated user should have access to the project.
+      #
+      # '/orgs/:org/projects/:project/envs' POST
+      #
+      # name - Name of the environment
+      # description - Description of the environment
+      def create(name, description, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:description] = description
+
+        @client.post("/orgs/#{@org}/projects/#{@project}/envs", body, options)
+      end
+
+      # Get an environment of the project the user has access to.
+      #
+      # '/orgs/:org/projects/:project/envs/:env' GET
+      #
+      # env - Name of the environment
+      def retrieve(env, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/projects/#{@project}/envs/#{env}", body, options)
+      end
+
+      # Update an environment. Authenticated user should have access to the project.
+      #
+      # '/orgs/:org/projects/:project/envs/:env' PATCH
+      #
+      # env - Name of the environment
+      # description - Description of the environment
+      def update(env, description, options = {})
+        body = options.fetch(:body, {})
+        body[:description] = description
+
+        @client.patch("/orgs/#{@org}/projects/#{@project}/envs/#{env}", body, options)
+      end
+
+      # Delete the given environment of the project. Authenticated user should have access to the project. Cannot delete the default environment.
+      #
+      # '/orgs/:org/projects/:project/envs/:env' DELETE
+      #
+      # env - Name of the environment
+      def destroy(env, options = {})
+        body = options.fetch(:body, {})
+
+        @client.delete("/orgs/#{@org}/projects/#{@project}/envs/#{env}", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/confy/api/members.rb

@@ -0,0 +1,45 @@
+module Confy
+
+  module Api
+
+    # Teams contain a list of users. The Authenticated user should be the owner of the organization.
+    #
+    # org - Name of the organization
+    # team - Name of the team
+    class Members
+
+      def initialize(org, team, client)
+        @org = org
+        @team = team
+        @client = client
+      end
+
+      # Add the user to the given team. The __user__ in the request needs to be a string.
+      #
+      # '/orgs/:org/teams/:team/member' POST
+      #
+      # user - Username of the user
+      def add(user, options = {})
+        body = options.fetch(:body, {})
+        body[:user] = user
+
+        @client.post("/orgs/#{@org}/teams/#{@team}/member", body, options)
+      end
+
+      # Remove users from the given team. The __user__ in the request needs to be a string. Cannot delete the default member in a team.
+      #
+      # '/orgs/:org/teams/:team/member' DELETE
+      #
+      # user - Username of the user
+      def remove(user, options = {})
+        body = options.fetch(:body, {})
+        body[:user] = user
+
+        @client.delete("/orgs/#{@org}/teams/#{@team}/member", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/confy/api/orgs.rb

@@ -18,6 +18,20 @@ module Confy
         @client.get("/orgs", body, options)
       end
 
+      # Create an organization with a name and the email for billing.
+      #
+      # '/orgs' POST
+      #
+      # name - Name of the organization
+      # email - Billing email of the organization
+      def create(name, email, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:email] = email
+
+        @client.post("/orgs", body, options)
+      end
+
       # Get an organization the user has access to.
       #
       # '/orgs/:org' GET

data/lib/confy/api/projects.rb

@@ -0,0 +1,77 @@
+module Confy
+
+  module Api
+
+    # An organization can contain any number of projects.
+    #
+    # org - Name of the organization
+    class Projects
+
+      def initialize(org, client)
+        @org = org
+        @client = client
+      end
+
+      # List all the projects of the organization which can be seen by the authenticated user.
+      #
+      # '/orgs/:org/projects' GET
+      def list(options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/projects", body, options)
+      end
+
+      # Create a project for the given organization. Authenticated user should be the owner of the organization.
+      #
+      # '/orgs/:org/projects' POST
+      #
+      # name - Name of the project
+      # description - Description of the project
+      def create(name, description, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:description] = description
+
+        @client.post("/orgs/#{@org}/projects", body, options)
+      end
+
+      # Get a project the user has access to.
+      #
+      # '/orgs/:org/projects/:project' GET
+      #
+      # project - Name of the project
+      def retrieve(project, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/projects/#{project}", body, options)
+      end
+
+      # Update a project. Authenticated user should be the owner of the organization.
+      #
+      # '/orgs/:org/projects/:project' PATCH
+      #
+      # project - Name of the project
+      # description - Description of the project
+      def update(project, description, options = {})
+        body = options.fetch(:body, {})
+        body[:description] = description
+
+        @client.patch("/orgs/#{@org}/projects/#{project}", body, options)
+      end
+
+      # Delete the given project. Cannot delete the default project in the organization. Authenticated user should be the owner of the organization.
+      #
+      # '/orgs/:org/projects/:project' DELETE
+      #
+      # project - Name of the project
+      def destroy(project, options = {})
+        body = options.fetch(:body, {})
+
+        @client.delete("/orgs/#{@org}/projects/#{project}", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/confy/api/teams.rb

@@ -0,0 +1,77 @@
+module Confy
+
+  module Api
+
+    # Every organization will have a default team named Owners. Owner of the organization will be a default member for every team.
+    #
+    # org - Name of the organization
+    class Teams
+
+      def initialize(org, client)
+        @org = org
+        @client = client
+      end
+
+      # List teams of the given organization authenticated user is a member of.
+      #
+      # '/orgs/:org/teams' GET
+      def list(options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/teams", body, options)
+      end
+
+      # Create a team for the given organization. Authenticated user should be the owner of the organization.
+      #
+      # '/orgs/:org/teams' POST
+      #
+      # name - Name of the team
+      # description - Description of the team
+      def create(name, description, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:description] = description
+
+        @client.post("/orgs/#{@org}/teams", body, options)
+      end
+
+      # Get a team the user is member of.
+      #
+      # '/orgs/:org/teams/:team' GET
+      #
+      # team - Name of the team
+      def retrieve(team, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/orgs/#{@org}/teams/#{team}", body, options)
+      end
+
+      # Update a team. Authenticated user should be the owner of the organization.
+      #
+      # '/orgs/:org/teams/:team' PATCH
+      #
+      # team - Name of the team
+      # description - Description of the team
+      def update(team, description, options = {})
+        body = options.fetch(:body, {})
+        body[:description] = description
+
+        @client.patch("/orgs/#{@org}/teams/#{team}", body, options)
+      end
+
+      # Delete the given team. Cannot delete the default team in the organization. Authenticated user should be the owner of the organization.
+      #
+      # '/orgs/:org/teams/:team' DELETE
+      #
+      # team - Name of the team
+      def destroy(team, options = {})
+        body = options.fetch(:body, {})
+
+        @client.delete("/orgs/#{@org}/teams/#{team}", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/confy/api/user.rb

@@ -9,7 +9,7 @@ module Confy
         @client = client
       end
 
-      # Get the authenticated user's info.
+      # Get the authenticated user's profile.
       #
       # '/user' GET
       def retrieve(options = {})

data/lib/confy/client.rb

@@ -3,6 +3,12 @@ require "json"
 
 require "confy/api/user"
 require "confy/api/orgs"
+require "confy/api/teams"
+require "confy/api/members"
+require "confy/api/projects"
+require "confy/api/access"
+require "confy/api/envs"
+require "confy/api/config"
 
 module Confy
 
@@ -22,6 +28,53 @@ module Confy
       Confy::Api::Orgs.new(@http_client)
     end
 
+    # Every organization will have a default team named Owners. Owner of the organization will be a default member for every team.
+    #
+    # org - Name of the organization
+    def teams(org)
+      Confy::Api::Teams.new(org, @http_client)
+    end
+
+    # Teams contain a list of users. The Authenticated user should be the owner of the organization.
+    #
+    # org - Name of the organization
+    # team - Name of the team
+    def members(org, team)
+      Confy::Api::Members.new(org, team, @http_client)
+    end
+
+    # An organization can contain any number of projects.
+    #
+    # org - Name of the organization
+    def projects(org)
+      Confy::Api::Projects.new(org, @http_client)
+    end
+
+    # List of teams who has access to the project. Default team __Owners__ will have access to every project. Authenticated user should be the owner of the organization for the below endpoints.
+    #
+    # org - Name of the organization
+    # project - Name of the project
+    def access(org, project)
+      Confy::Api::Access.new(org, project, @http_client)
+    end
+
+    # Every project has a default environment named Production. Each environment has one configuration document which can have many keys and values.
+    #
+    # org - Name of the organization
+    # project - Name of the project
+    def envs(org, project)
+      Confy::Api::Envs.new(org, project, @http_client)
+    end
+
+    # Any member of the team which has access to the project can retrieve any of it's environment's configuration document or edit it.
+    #
+    # org - Name of the organization
+    # project - Name of the project
+    # env - Name of the environment
+    def config(org, project, env)
+      Confy::Api::Config.new(org, project, env, @http_client)
+    end
+
   end
 
 end

data/lib/confy/config.rb

@@ -0,0 +1,26 @@
+module Confy
+
+  class Config
+
+    def self.new(url = {})
+
+      if url.is_a?(String)
+        regex = Regexp.new('(https?:\/\/)(.*):(.*)@(.*)\/orgs\/([a-z0-9]*)\/projects\/([a-z0-9]*)\/envs\/([a-z0-9]*)\/config', true)
+        matches = regex.match(url)
+
+        url = {
+          :host => matches[1] + matches[4], :user => matches[2], :pass => matches[3],
+          :org => matches[5], :project => matches[6], :env => matches[7]
+        }
+      end
+
+      client = Confy::Client.new({
+        :username => url[:user], :password => url[:pass]
+      }, { :base => url[:host] })
+
+      client.config(url[:org], url[:project], url[:env]).retrieve().body
+    end
+
+  end
+
+end

data/lib/confy/http_client.rb

@@ -17,7 +17,7 @@ module Confy
 
         @options = {
           :base => "https://api.confy.io",
-          :user_agent => "alpaca/0.2.0 (https://github.com/pksunkara/alpaca)"
+          :user_agent => "alpaca/0.2.1 (https://github.com/pksunkara/alpaca)"
         }
 
         @options.update(options)

data/lib/confyio.rb

@@ -1,6 +1,7 @@
 require "rubygems"
 
 require "confy/client"
+require "confy/config"
 require "confy/error"
 require "confy/http_client"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confyio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Pavan Kumar Sunkara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -49,11 +49,18 @@ files:
 - lib/confy/http_client/response.rb
 - lib/confy/http_client/error_handler.rb
 - lib/confy/http_client/auth_handler.rb
+- lib/confy/api/access.rb
+- lib/confy/api/envs.rb
+- lib/confy/api/teams.rb
+- lib/confy/api/config.rb
+- lib/confy/api/projects.rb
+- lib/confy/api/members.rb
 - lib/confy/api/orgs.rb
 - lib/confy/api/user.rb
 - lib/confy/http_client.rb
 - lib/confy/client.rb
 - lib/confy/error/client_error.rb
+- lib/confy/config.rb
 - lib/confy/error.rb
 - lib/confyio.rb
 homepage: https://confy.io