zedkit 1.1.5 → 1.2.0

data/README.rdoc

@@ -5,4 +5,4 @@ More details TBA.
 
 == Copyright
 
-Copyright (c) 2010 Zedkit. See LICENSE for details. http://zedkit.com.
+Copyright (c) 2010-2012 Zedkit. See LICENSE for details. http://zedkit.com.

data/Rakefile

@@ -1,4 +1,4 @@
-##
+#
 # Copyright (c) Zedkit.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
@@ -13,13 +13,13 @@
 # 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.
-##
+#
 
-require 'rubygems'
-require 'rake'
+require "rubygems"
+require "rake"
 
 begin
-  require 'jeweler'
+  require "jeweler"
   Jeweler::Tasks.new do |gem|
     gem.name = "zedkit"
     gem.summary = %Q{gem for Zedkit}
@@ -30,30 +30,30 @@ begin
     gem.authors = ["Zedkit"]
     gem.rubyforge_project = "zedkit"
 
-    gem.files = FileList['[A-Z]*', 'bin/*', 'lib/**/*.rb', 'test/**/*.rb']
+    gem.files = FileList["[A-Z]*", "bin/*", "lib/**/*.rb", "test/**/*.rb"]
     gem.executables = %w(zedkit)
     gem.default_executable = %q{zedkit}
 
-    gem.add_dependency 'json', '>= 1.4.0'
-    gem.add_dependency 'nestful'
+    gem.add_dependency "json", ">= 1.4.0"
+    gem.add_dependency "nestful"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
+require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
   test.verbose = true
 end
 
 begin
-  require 'rcov/rcovtask'
+  require "rcov/rcovtask"
   Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
+    test.libs << "test"
+    test.pattern = "test/**/test_*.rb"
     test.verbose = true
   end
 rescue LoadError
@@ -65,11 +65,11 @@ end
 task :test => :check_dependencies
 task :default => :test
 
-require 'rake/rdoctask'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "zedkit #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end

data/VERSION

@@ -1 +1 @@
-1.1.5
+1.2.0

data/bin/zedkit

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-##
+#
 # Copyright (c) Zedkit.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
@@ -14,9 +14,9 @@
 # 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.
-##
+#
 
-require 'zedkit'
+require "zedkit"
 
 Dir["#{File.dirname(__FILE__)}/../lib/cli/*.rb"].each {|ci| require ci }
 

data/lib/cli/config.rb

@@ -1,4 +1,4 @@
-##
+#
 # Copyright (c) Zedkit.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
@@ -13,7 +13,7 @@
 # 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.
-##
+#
 
 Zedkit.configure do |zk|
   zk.exceptions = true

data/lib/zedkit.rb

@@ -1,4 +1,4 @@
-##
+#
 # Copyright (c) Zedkit.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
@@ -13,25 +13,27 @@
 # 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.
-##
+#
 
-require 'rubygems'
-require 'json'
-require 'nestful'
+require "rubygems"
+require "json"
+require "nestful"
 
-require 'zedkit/ext/hash.rb'
+require "zedkit/ext/array.rb"
+require "zedkit/ext/hash.rb"
+require "zedkit/ext/benchmark.rb"
 
 module Zedkit
   class << self
     def countries
-      rs = Zedkit::Client.get('entities/countries')
+      rs = Zedkit::Client.get("entities/countries")
       if rs && block_given?
         rs.is_a?(Array) ? rs.each {|i| yield(i) } : yield(rs)
       end
       rs
     end
     def regions(zks = {})
-      rs = Zedkit::Client.get('entities/regions', nil, zks)
+      rs = Zedkit::Client.get("entities/regions", nil, zks)
       if rs && block_given?
         rs.is_a?(Array) ? rs.each {|i| yield(i) } : yield(rs)
       end
@@ -39,7 +41,7 @@ module Zedkit
     end
 
     def entities
-      rs = Zedkit::Client.get('entities/zedkit')
+      rs = Zedkit::Client.get("entities/zedkit")
       if rs && block_given?
         rs.is_a?(Array) ? rs.each {|i| yield(i) } : yield(rs)
       end
@@ -52,7 +54,7 @@ module Zedkit
     # Call the configure method within an application configuration initializer to set your project key,
     # and other goodies:
     #   Zedkit.configure do |zb|
-    #     zb.project_key = 'from.zedkit.com.members.area'
+    #     zb.project_key = "from.zedkit.com.members.area"
     #     zb.ssl = true
     #   end
     #
@@ -65,22 +67,28 @@ module Zedkit
   end
 end
 
-require 'zedkit/client/configuration.rb'
-require 'zedkit/client/client.rb'
-require 'zedkit/client/exceptions.rb'
+require "zedkit/client/configuration.rb"
+require "zedkit/client/client.rb"
+require "zedkit/client/exceptions.rb"
 
-require 'zedkit/cli/bottom.rb'
-require 'zedkit/cli/exceptions.rb'
-require 'zedkit/cli/projects.rb'
-require 'zedkit/cli/runner.rb'
-require 'zedkit/cli/text.rb'
+require "zedkit/cli/bottom.rb"
+require "zedkit/cli/exceptions.rb"
+require "zedkit/cli/projects.rb"
+require "zedkit/cli/runner.rb"
+require "zedkit/cli/text.rb"
 
-require 'zedkit/instances/instance.rb'
-require 'zedkit/instances/project.rb'
+require "zedkit/instances/instance.rb"
+require "zedkit/instances/project.rb"
 
-require 'zedkit/resources/projects.rb'
-require 'zedkit/resources/users.rb'
-require 'zedkit/resources/emails.rb'
-require 'zedkit/resources/email_settings.rb'
+require "zedkit/resources/projects.rb"
+require "zedkit/resources/project_keys.rb"
+require "zedkit/resources/project_admins.rb"
+require "zedkit/resources/users.rb"
+require "zedkit/resources/blogs.rb"
+require "zedkit/resources/blog_posts.rb"
+require "zedkit/resources/shorteners.rb"
+require "zedkit/resources/shortened_urls.rb"
+require "zedkit/resources/emails.rb"
+require "zedkit/resources/email_settings.rb"
 
-require 'zedkit/rails/sessions' if defined?(Rails::Railtie)
+require "zedkit/rails/sessions" if defined?(Rails::Railtie)

data/lib/zedkit/cli/runner.rb

@@ -19,14 +19,14 @@ module Zedkit
   module CLI
     class Runner
       attr_accessor :user_key, :username, :password, :locale
-      attr_reader :section, :command, :items
+      attr_reader :config, :section, :command, :items
 
       SECTIONS = ['projects']
-      CONFIG = "#{File.expand_path('~')}/.zedkit"
 
       def initialize
         @user_key, @username, @password = nil, nil, nil
         @locale = :en
+        @config = File.expand_path('~') << "/.zedkit"
         if !ARGV.empty? && ARGV[0].include?(":")
           @section = ARGV[0].split(":")[0]
           @command = ARGV[0].split(":")[1]
@@ -76,7 +76,7 @@ module Zedkit
           if has_section? && has_command?
             if has_credentials?
               unless has_user_key?
-                @user_key = Zedkit::Users.verify(:username => username, :password => password)['user_key']
+                @user_key = Zedkit::Users.verify(:login => username, :password => password)['user_key']
               end
               run
             else
@@ -108,18 +108,24 @@ module Zedkit
       def commands
            "\n" \
         << "== #{Zedkit::CLI.tt(locale, :commands, :projects)}\n\n" \
-        << "list                                # #{Zedkit::CLI.tt(locale, :commands, :projects_list)}\n" \
-        << "show <uuid>                         # #{Zedkit::CLI.tt(locale, :commands, :projects_show)}\n" \
-        << "create <name> key=value [...]       # #{Zedkit::CLI.tt(locale, :commands, :projects_create)}\n" \
-        << "update <uuid> key=value [...]       # #{Zedkit::CLI.tt(locale, :commands, :projects_update)}\n" \
-        << "delete <uuid>                       # #{Zedkit::CLI.tt(locale, :commands, :projects_delete)}\n\n" \
+        << "list                                        # #{Zedkit::CLI.tt(locale, :commands, :projects_list)}\n" \
+        << "show <uuid>                                 # #{Zedkit::CLI.tt(locale, :commands, :projects_show)}\n" \
+        << "create <name> key=value [...]               # #{Zedkit::CLI.tt(locale, :commands, :projects_create)}\n" \
+        << "update <uuid> key=value [...]               # #{Zedkit::CLI.tt(locale, :commands, :projects_update)}\n" \
+        << "delete <uuid>                               # #{Zedkit::CLI.tt(locale, :commands, :projects_delete)}\n\n" \
+        << "== User Commands\n\n" \
+        << "users:list <project uuid>                   # #{Zedkit::CLI.tt(locale, :commands, :users_list)}\n" \
+        << "users:show <project uuid> <login>           # #{Zedkit::CLI.tt(locale, :commands, :users_show)}\n" \
+        << "users:create <project> key=value [...]      # #{Zedkit::CLI.tt(locale, :commands, :users_create)}\n" \
+        << "users:update <uuid> key=value [...]         # #{Zedkit::CLI.tt(locale, :commands, :users_update)}\n" \
+        << "users:delete <uuid>                         # #{Zedkit::CLI.tt(locale, :commands, :users_delete)}\n\n" \
         << "==\n\n"
       end
 
       private
       def set_credentials
-        if File.exists?(CONFIG)
-          st = File.open(CONFIG).readlines.map(&:strip).delete_if {|i| i.empty? }
+        if File.exists?(config)
+          st = File.open(config).readlines.map(&:strip).delete_if {|i| i.empty? }
           if st.length > 2
             @username = st[0]
             @password = st[1]
@@ -132,8 +138,8 @@ module Zedkit
         ARGV.length > 1 ? @items = ARGV.slice(1, ARGV.length - 1) : @items = nil
       end
       def set_locale
-        if File.exists?(CONFIG)
-          st = File.open(CONFIG).readlines.map(&:strip).delete_if {|i| i.empty? }
+        if File.exists?(config)
+          st = File.open(config).readlines.map(&:strip).delete_if {|i| i.empty? }
           if st.length >= 2
             @locale = st[st.length - 1].to_sym if Zedkit::CLI.include?(st[st.length - 1].to_sym)
           end

data/lib/zedkit/cli/text.rb

@@ -35,7 +35,12 @@ module Zedkit
           :projects_show => "Show Zedkit project details",
           :projects_create => "Create a new Zedkit project",
           :projects_update => "Update an existing Zedkit project",
-          :projects_delete => "Delete an existing Zedkit project"
+          :projects_delete => "Delete an existing Zedkit project",
+          :users_list => "List a project's users",
+          :users_show => "Show user details",
+          :users_create => "Create a new user",
+          :users_update => "Update an existing user",
+          :users_delete => "Delete an existing user"
         }
       }
     }

data/lib/zedkit/cli/users.rb

@@ -0,0 +1,48 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module Zedkit
+  module CLI
+    class Users < Zedkit::CLI::Bottom
+      class << self
+        def list(opts = {})
+          puts "\n" << Zedkit::CLI.ee(opts[:locale], :general, :not_done) << "\n\n"
+        end
+
+        def show(opts = {})
+          puts "\n" << Zedkit::CLI.ee(opts[:locale], :general, :not_done) << "\n\n"
+        end
+
+        def create(opts = {})
+          puts "\n" << Zedkit::CLI.ee(opts[:locale], :general, :not_done) << "\n\n"
+        end
+
+        def update(opts = {})
+          puts "\n" << Zedkit::CLI.ee(opts[:locale], :general, :not_done) << "\n\n"
+        end
+        
+        def delete(opts = {})
+          puts "\n" << Zedkit::CLI.ee(opts[:locale], :general, :not_done) << "\n\n"
+        end
+
+        protected
+        def before_show_update_delete(opts = {})
+        end
+      end
+    end
+  end
+end

data/lib/zedkit/client/client.rb

@@ -1,4 +1,4 @@
-##
+#
 # Copyright (c) Zedkit.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
@@ -13,20 +13,20 @@
 # 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.
-##
+#
 
 module Zedkit
   module Client
     class << self
-      def crud(method, resource, zks, da, &block)
+      def crud(method, resource, zks, del_keys, &block)
         rs = nil
         case method
         when :get
-          rs = submit_request(:get, resource, zks[:user_key], zks.zdelete_keys!(%w(user_key uuid) + da))
+          rs = submit_request(:get, resource, zks[:user_key], zks.zdelete_keys!(%w(user_key uuid) + del_keys))
         when :create
-          rs = submit_request(:post, resource, zks[:user_key], zks.zdelete_keys!(%w(user_key) + da))
+          rs = submit_request(:post, resource, zks[:user_key], zks.zdelete_keys!(%w(user_key) + del_keys))
         when :update
-          rs = submit_request(:put, resource, zks[:user_key], zks.zdelete_keys!(%w(user_key uuid) + da))
+          rs = submit_request(:put, resource, zks[:user_key], zks.zdelete_keys!(%w(user_key uuid) + del_keys))
         when :delete
           rs = submit_request(:delete, resource, zks[:user_key])
         end
@@ -36,42 +36,49 @@ module Zedkit
         rs
       end
 
-      def verify(username, password)
-        submit_request(:verify, 'users/verify', nil, {}, { :user => username, :password => password })
+      def verify(login, password)
+        submit_request(:verify, "users/verify", nil, {}, { :user => login, :password => password })
       end
-      def get(resource, user_key = nil, params = {})
-        submit_request(:get, resource, user_key, params)
+      def get(resource, user_key = nil, params = {}, &block)
+        rs = submit_request(:get, resource, user_key, params)
+        if rs && block_given?
+          rs.is_a?(Array) ? rs.each {|i| yield(i) } : yield(rs)
+        end
+        rs
       end
 
       protected
       def submit_request(method, rs, user_key = nil, params = {}, options = {})
         rh = nil
-        begin
-          http_request(method, resource_url(rs), user_key, params.flatten_zedkit_params!, options) do |nh|
-            rh = JSON.parse(nh)
-            if rh.is_a?(Hash) && rh.has_key?('status') && Zedkit.configuration.exceptions?
-              raise DataValidationError.new(:http_code => 200, :api_code => rh['status']['code'],
-                                            :errors => rh['errors'],
-                                            :message => rh['status']['message'] << " [#{method.upcase} #{resource_url(rs)}]")
+        Benchmark.zk_time(method, Zedkit.configuration.debug?) do
+          begin
+            http_request(method, resource_url(rs), user_key, params.flatten_zedkit_params!, options) do |nh|
+              rh = JSON.parse(nh)
+              if rh.is_a?(Hash) && rh.has_key?("status") && Zedkit.configuration.exceptions?
+                raise DataValidationError.new(:http_code => 200, :api_code => rh["status"]["code"],
+                                              :errors => rh["errors"],
+                                              :message => rh["status"]["message"] << " [#{method.upcase} #{resource_url(rs)}]")
+              end
+            end
+          rescue Net::HTTPBadResponse
+            ## TBD
+          rescue Nestful::UnauthorizedAccess
+            if Zedkit.configuration.exceptions?
+              raise Zedkit::Client::UnauthorizedAccess.new(:http_code => 401,
+                                             :message => "User Credentials are Invalid [#{method.upcase} #{resource_url(rs)}]")
+            end
+          rescue Nestful::ResourceNotFound
+            if Zedkit.configuration.exceptions?
+              raise Zedkit::Client::ResourceNotFound.new(:http_code => 404,
+                                        :message => "Resource Requested does not Exist [#{method.upcase} #{resource_url(rs)}]")
+            end
+          rescue Nestful::ForbiddenAccess
+            if Zedkit.configuration.exceptions?
+              raise Zedkit::Client::ForbiddenAccess.new(:http_code => 403,
+                                  :message => "Access Denied to the Resource Requested [#{method.upcase} #{resource_url(rs)}]")
             end
           end
-        rescue Net::HTTPBadResponse
-          ## TBD
-        rescue Nestful::UnauthorizedAccess
-          if Zedkit.configuration.exceptions?
-            raise Zedkit::Client::UnauthorizedAccess.new(:http_code => 401,
-                                           :message => "User Credentials are Invalid [#{method.upcase} #{resource_url(rs)}]")
-          end
-        rescue Nestful::ResourceNotFound
-          if Zedkit.configuration.exceptions?
-            raise Zedkit::Client::ResourceNotFound.new(:http_code => 404,
-                                      :message => "Resource Requested does not Exist [#{method.upcase} #{resource_url(rs)}]")
-          end
-        rescue Nestful::ForbiddenAccess
-          if Zedkit.configuration.exceptions?
-            raise Zedkit::Client::ForbiddenAccess.new(:http_code => 403,
-                                :message => "Access Denied to the Resource Requested [#{method.upcase} #{resource_url(rs)}]")
-          end
+          rh
         end
         rh
       end