zendesk-populator 0.0.2

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,61 @@
+zendesk-populator
+=================
+
+Description
+-----------
+
+A simple command line tool to populate Zendesk organizations and users
+from a CSV file.
+
+Requirements
+------------
+
+* `httparty`
+
+Installation & Usage
+-------------------
+
+1.  Install the zendesk-populator via the gem
+
+        $ gem install zendesk-populator
+
+3.  Update the `zendesk_site`, `zendesk_user` and `zendesk_password` 
+    variables in the `zdpop_config.yaml` file. The default location for the
+    file is `/etc/zdpop_config.yaml`. You can override this with the 
+    `-c` or `--config-file` command line option. An example file is 
+    included.
+
+4.  The zdpop_data.csv file contains the data to be loaded in the form:
+    
+        org_name,user_name,email_address
+    
+    The default file location is `/tmp/zdpop_data.csv` but you can
+    override this via the `-d` or `--data-file` command line option.
+
+5.  Run the command to create the required organizations and users:
+
+        $ zdpop
+
+Author
+------
+
+James Turnbull <james@lovedthanlost.net>
+
+License
+-------
+
+    Author:: James Turnbull (<james@lovedthanlost.net>)
+    Copyright:: Copyright (c) 2011 James Turnbull
+    License:: Apache License, Version 2.0
+
+    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.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__) + '/lib')
+
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+require 'zdpop/version'
+
+version = Zdpop::Version::VERSION
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "zendesk-populator"
+  gem.version = version
+  gem.platform = Gem::Platform::RUBY
+  gem.homepage = "http://github.com/jamtur01/zendesk-populator/"
+  gem.license = "APL2"
+  gem.summary = %Q{A command line tool to generate Zendesk orgs and users from CSV.}
+  gem.description = %Q{A command line tool to generate Zendesk orgs and users from CSV.}
+  gem.email = "james@lovedthanlost.net"
+  gem.authors = ["James Turnbull"]
+  gem.add_dependency "httparty"
+  gem.bindir       = "bin"
+  gem.executables  = %w( zdpop )
+  gem.require_path = 'lib'
+  gem.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "zendesk-populator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/zdpop

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+#--
+# Author:: James Turnbull (<james@lovedthanlost.net>)
+# Copyright:: Copyright (c) 2011 James Turnbull
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require 'rubygems'
+require 'optparse'
+require 'zdpop/populator'
+require 'zdpop/version'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  # Set a banner, displayed at the top
+  # of the help screen.
+  opts.banner = 'Usage: zdpop [options] ...'
+
+  opts.separator ''
+  opts.separator 'Configuration options:'
+
+  options[:cfile] = '/etc/zdpop_config.yaml'
+  opts.on( '-c', '--config-file', 'The location of the zdpop configuration file.') { |cfile|
+    options[:cfile] = cfile
+  }
+
+  options[:dfile] = '/tmp/zdpop_data.csv'
+  opts.on( '-d', '--data-file', 'The location of the CSV data file containing the users and orgs to be created.') { |dfile|
+    options[:dfile] = dfile
+  }
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  opts.on_tail('-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts Zdpop::Version::VERSION
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+  Zdpop::Populator.new(options[:cfile],options[:dfile])
+rescue OptionParser::InvalidArgument, OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $!.to_s
+  puts optparse
+  exit
+end

data/lib/zdpop/populator.rb

@@ -0,0 +1,100 @@
+require 'yaml'
+require 'csv'
+
+begin
+  require 'httparty'
+rescue LoadError => e
+  puts "You need the `httparty` gem to use the Zendesk Populator"
+end
+
+module Zdpop
+  class Populator
+
+    def initialize(configfile,datafile)
+      begin
+        # Set configuration
+        raise "Configuration file #{configfile} missing" unless File.file? configfile
+        config = YAML.load_file(configfile)
+        @site = config[:zendesk_site]
+        @user = config[:zendesk_user]
+        @password = config[:zendesk_password]
+        raise "Missing Zendesk site, user or password" if [ @site, @user, @password ].include?(nil)
+
+        # Load data
+        raise "Data file #{datafile} missing" unless File.file? datafile
+        data = CSV.read(datafile)
+        raise "No Zendesk data loaded - file empty" unless data != []
+        create(data)
+      rescue Exception => e
+        puts e.message
+      end
+    end
+
+    def create(data)
+      orglist = list_orgs
+      userlist = list_users
+      data.each { |d|
+        org = d[0]
+        name = d[1]
+        email = d[2]
+        domain = email.gsub(/^.*\@(.*)$/, '\1')
+        unless orglist.include?(org)
+          create_org(org,domain)
+        end
+        unless userlist.include?(name)
+          create_user(name,email,org)
+        end
+      }
+    end
+
+    def list_orgs
+      orglist = []
+      organizations = HTTParty.get("#{@site}api/v1/organizations.json", :basic_auth => {:username=>"#{@user}", :password=> "#{@password}" } )
+
+      organizations.each { |o|
+          orglist << o["name"]
+      }
+      return orglist
+    end
+
+    def lookup_org_id(org)
+      orgtable = {}
+      organizations = HTTParty.get("#{@site}api/v1/organizations.json", :basic_auth => {:username=>"#{@user}", :password=> "#{@password}" } )
+      organizations.each { |o|
+        orgtable["#{o["name"]}"] = o["id"]
+      }
+      id = orgtable["#{org}"]
+      return id
+    end
+
+    def list_users
+      userlist = []
+      users = HTTParty.get("#{@site}users.json", :basic_auth => {:username=>"#{@user}", :password=> "#{@password}" } )
+      users.each { |u|
+        userlist << u["name"]
+      }
+      return userlist
+    end
+
+    def create_org(org,domain)
+      payload = { :organization => { :name => org, :is_shared => 'true', :is_shared_comments => 'true', :default => domain } }
+      response = HTTParty.post("#{@site}api/v1/organizations.json", :basic_auth => {:username=>"#{@user}", :password=> "#{@password}" }, :body => payload )
+      if response.code == 201
+        puts "Created organization #{org}"
+      else
+        puts "Response code: #{response.code} - #{response.body}"
+      end
+    end
+
+    def create_user(name,email,org)
+      id = lookup_org_id(org)
+      payload = { :user => { :name => name, :email => email, :roles => '0', :restriction_id => '2', :organization_id => id } }
+      response = HTTParty.post("#{@site}users.json", :basic_auth => {:username=>"#{@user}", :password=> "#{@password}" }, :body => payload )
+      if response.code == 200
+        puts "Created user #{name}"
+      else
+        puts "Response code: #{response.code} - #{response.body}"
+      end
+    end
+  end
+end

data/lib/zdpop/version.rb

@@ -0,0 +1,5 @@
+module Zdpop
+  module Version
+    VERSION = '0.0.2'
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: zendesk-populator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- James Turnbull
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-14 00:00:00 +10:00
+default_executable: zdpop
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A command line tool to generate Zendesk orgs and users from CSV.
+email: james@lovedthanlost.net
+executables: 
+- zdpop
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- bin/zdpop
+- lib/zdpop/populator.rb
+- lib/zdpop/version.rb
+has_rdoc: true
+homepage: http://github.com/jamtur01/zendesk-populator/
+licenses: 
+- APL2
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A command line tool to generate Zendesk orgs and users from CSV.
+test_files: []
+