easy_contact 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.

data/README.md

@@ -0,0 +1,121 @@
+## EasyContact
+
+This is a very simple contact system for Rails. Because it is so simple, you should fork and modify it for your own purpose.
+
+This gem is used in my other projects, thus, it will be kept updated, albeit slowly.
+
+## Install
+
+    rails generate easy_contact:migration
+    rake db:migrate
+    rake db:test:prepare
+
+## Basic Usage
+
+  You need to define __acts_as_contactable__ in a contact model like this:
+
+    class User < ActiveRecord::Base
+      acts_as_contactable
+    end
+
+  You can manage contact information like this:
+
+    user.addresses
+    user.phones
+
+## Entry
+
+  Each information is stored in an entry, no matter it is an address or a phone number. EasyContact use STI to create classes of address and phone. An entry contains these fields:
+
+    type: string
+    label: string
+    content: text
+    extra: string
+    addition: string
+    country: string
+    locale: string
+    primary: boolean
+  
+  All of them are in string format. The **type** defines this entry an address or a phone number. The use of other fields depend on the type.
+
+  **country** is used in address and phone type. It is set as 2-letter abbreviation of country like US, UK.
+
+  **locale** set the language of this entry. A person might have English and Chinese name.
+
+  **primary** specify the main entry of a type, for example, the main address of a person.
+
+### Name
+
+  It doesn't care the order of first and last name, or suffix and middle name. Just a string of the name this person use. Thus, it is your choice to put the name as 'John Doe' or 'Doe, John'.
+
+    Content: string of name
+    Label: 'fullname', 'nickname'
+    Extra: not in use
+    Addition: not in use
+
+### Address
+
+  It is in a free form for address. Think the address in the name card. 
+
+    Content: string of address
+    Label: 'home', 'office'
+    Extra: not in use
+    Addition: not in use
+
+### Phone
+
+  It is in a free form of address. Thus, you can use 1-545-8342 or (545)8743. There is no need to put country code. The code can be derived from country field.
+
+    Content: string of phone number
+    Label: 'home', 'office'
+    Extra: not in use
+    Addition: not in use
+
+### Employment
+
+  It is in a free form of employment
+
+    Content: string of employer (company, organization)
+    Label: no predefined
+    Extra: title of this employment
+    Addition: year during this employment in free form, ex. 1998-2001.
+
+### Birthday
+
+  It is in seconds. Use __to_i__ to convert a date into seconds. Time zone is ignored. To avoid problem, always use UTC even if you are not born in UTC time zone.
+
+    Content: string in seconds
+    Label: no predefined
+    Extra: not in use
+    Addition: not in use
+
+### Email
+
+  It is in a free form of email
+
+    Content: string of email
+    Label: no predefined
+    Extra: not in use
+    Addition: not in use
+
+### Website
+
+  It is in a free form of website
+
+    Content: string of email
+    Label: no predefined
+    Extra: not in use
+    Addition: not in use
+
+### Instant Messenger
+
+  It is in a free form of website
+
+    Content: string of instant messenger ID
+    Label: 'google talk', 'skype', 'yahoo', 'msn', 'jabber'
+    Extra: not in use
+    Addition: not in use
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EasyContact'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+

data/app/models/easy_contact/address.rb

@@ -0,0 +1,2 @@
+class EasyContact::Address < EasyContact::Entry
+end

data/app/models/easy_contact/email.rb

@@ -0,0 +1,2 @@
+class EasyContact::Email < EasyContact::Entry
+end

data/app/models/easy_contact/entry.rb

@@ -0,0 +1,4 @@
+class EasyContact::Entry < ActiveRecord::Base
+  belongs_to :contactable
+  attr_accessible :addition, :content, :country, :extra, :label, :locale, :primary, :type
+end

data/app/models/easy_contact/name.rb

@@ -0,0 +1,2 @@
+class EasyContact::Name < EasyContact::Entry
+end

data/app/models/easy_contact/phone.rb

@@ -0,0 +1,2 @@
+class EasyContact::Phone < EasyContact::Entry
+end

data/app/models/easy_contact/website.rb

@@ -0,0 +1,2 @@
+class EasyContact::Website < EasyContact::Entry
+end

data/app/models/easy_contact.rb

@@ -0,0 +1,8 @@
+# For some reason, it does not work. Thus, it is put in lib/easy_contact.rb
+=begin
+module EasyContact
+  def self.table_name_prefix
+    'easy_contact_'
+  end
+end
+=end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/easy_contact/contactable.rb

@@ -0,0 +1,39 @@
+module EasyContact
+  module Contactable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :entries, :dependent => :destroy,
+        :class_name => 'EasyContact::Entry',
+        :foreign_key => 'contactable_id'
+      has_many :names, :dependent => :destroy,
+        :class_name => 'EasyContact::Name',
+        :foreign_key => 'contactable_id'
+      has_many :addresses, :dependent => :destroy,
+        :class_name => 'EasyContact::Address',
+        :foreign_key => 'contactable_id'
+      has_many :phones, :dependent => :destroy,
+        :class_name => 'EasyContact::Phone',
+        :foreign_key => 'contactable_id'
+      has_many :emails, :dependent => :destroy,
+        :class_name => 'EasyContact::Email',
+        :foreign_key => 'contactable_id'
+      has_many :websites, :dependent => :destroy,
+        :class_name => 'EasyContact::Website',
+        :foreign_key => 'contactable_id'
+
+      accepts_nested_attributes_for :entries, 
+        :names, :phones, :addresses, :emails, :websites,
+        :reject_if => :reject_entries,
+        :allow_destroy => true
+    end
+
+    module ClassMethods
+    end # end of class methods
+
+    def reject_entries(attributes)
+      attributes['content'].blank?
+    end
+
+  end
+end

data/lib/easy_contact/engine.rb

@@ -0,0 +1,4 @@
+module EasyContact
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/easy_contact/version.rb

@@ -0,0 +1,3 @@
+module EasyContact
+  VERSION = "0.0.1"
+end

data/lib/easy_contact.rb

@@ -0,0 +1,17 @@
+require "easy_contact/engine"
+require "easy_contact/contactable"
+
+module EasyContact
+  def self.table_name_prefix
+    'easy_contact_'
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  class ActiveRecord::Base
+    def self.acts_as_contactable(options = {})
+      options.reverse_merge!({})
+      include EasyContact::Contactable
+    end
+  end
+end

data/lib/generators/easy_contact/migration/migration_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module EasyContact
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc 'add easy contact'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number(path)
+      ActiveRecord::Generators::Base.next_migration_number(path)
+    end
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/easy_contact_migration'
+    end
+  end
+end

data/lib/generators/easy_contact/migration/templates/migration.rb

@@ -0,0 +1,18 @@
+class EasyContactMigration < ActiveRecord::Migration
+  def change
+    create_table :easy_contact_entries do |t|
+      t.string :type
+      t.string :label
+      t.text :content
+      t.string :addition
+      t.string :extra
+      t.string :country
+      t.string :locale
+      t.boolean :primary
+      t.references :contactable
+
+      t.timestamps
+    end
+    add_index :easy_contact_entries, :contactable_id
+  end
+end

data/lib/tasks/easy_contact_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :easy_contact do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: easy_contact
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yen-Ju Chen
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURNRENDQWhpZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREErTVJBd0RnWURWUVFEREFkNWFt
+  Tm8KWlc1NE1SVXdFd1lLQ1pJbWlaUHlMR1FCR1JZRloyMWhhV3d4RXpBUkJn
+  b0praWFKay9Jc1pBRVpGZ05qYjIwdwpIaGNOTVRNd01qQTNNREV5T0RJNFdo
+  Y05NVFF3TWpBM01ERXlPREk0V2pBK01SQXdEZ1lEVlFRRERBZDVhbU5vClpX
+  NTRNUlV3RXdZS0NaSW1pWlB5TEdRQkdSWUZaMjFoYVd3eEV6QVJCZ29Ka2lh
+  SmsvSXNaQUVaRmdOamIyMHcKZ2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJ
+  QkR3QXdnZ0VLQW9JQkFRRGZ6ZHRRbE55dzV5OTcwMXBScmRDTQpqVldHQU1K
+  N0R5YXQybWpEVkdoTXNIL2JlNGo4eW45N3BhNm15bUlRVXpRYVUxS1FDdzhW
+  K0ZkVjBoNHA3SE9wCnpqMy9tWEYxVWxjQkw1RXRJdHlkeTM2dmRhbkRIZGZH
+  YnpJWU1wbkpzR0E1Wk5EV3JCWFdMOWlRZmt1ck1lY3EKdi93NXI4MEtJYVpr
+  bDJ4TVc4am50MzNNWEhFQmpDQVNXZDF5Qk1semYxQU9yNzVkMGsyYllzU1Ur
+  R0V4eGV4WQpoUEZ6TE1STS9WSnhxaXRGYllubGdINXp5cUJPY0JtRzNIZDBW
+  YVJpMTM3WGpCRjRmZXJqMjFpWC9SVjROSU9aCkh6MlliVFZ6ODBOSk5IT3Ba
+  RGxTTkU0dm5JQU5wNWZubXdOa0FpM1BUTXhZWkM4OWpXREFCYnFFNzgzeFda
+  a1AKQWdNQkFBR2pPVEEzTUFrR0ExVWRFd1FDTUFBd0hRWURWUjBPQkJZRUZB
+  VXZaaTdmRXlTazQ5SFRFcmJmTUIySwpTNGlnTUFzR0ExVWREd1FFQXdJRXNE
+  QU5CZ2txaGtpRzl3MEJBUVVGQUFPQ0FRRUFnVWtpRmY3S1FiR3QxbFVxCmpR
+  aVY4bm9sMzArZFdTSVEwL2FUTk4xbGJnYUtYcTg2SnFwOUlJV2JROW9RTEh1
+  ZW1YcTBGeDdhYnJkSXFKQXcKUUM3VWxlWnR4UmZUOHBrM1RJRk9paW5HYlds
+  Ry9pSlM4NVB2MERXbkFUM2NsNzZNL3I0TStRSE91MzhWQU9KeQo2clVIV2lh
+  LzlJekFKWlo4UHRPUGkwSGtUd1pJdnBTNmpMRjZqZXEyd3IrUThuYVFaNlMv
+  Sm5hbEJlNm43ZExTCkxPRXAzV3dMYWZCWjlWdElRay92Z0IzUUp4b3I4WDRS
+  M0lBc1Z2QzJZa0d3SjA5cUZWM1dRV1daU1NYUkp5ajUKMER3VStLZlV0YTRI
+  V1JyK2psKzRrWWVpVUtnYW1kdjJwUTRWYUo4M1ZHQzNGSXBVazlUVUxDTTN2
+  NWlIYkRRdQpvWnNXQ1E9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A very simple contact system for Rails
+email:
+- yjchenx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/easy_contact/address.rb
+- app/models/easy_contact/email.rb
+- app/models/easy_contact/entry.rb
+- app/models/easy_contact/name.rb
+- app/models/easy_contact/phone.rb
+- app/models/easy_contact/website.rb
+- app/models/easy_contact.rb
+- config/routes.rb
+- lib/easy_contact/contactable.rb
+- lib/easy_contact/engine.rb
+- lib/easy_contact/version.rb
+- lib/easy_contact.rb
+- lib/generators/easy_contact/migration/migration_generator.rb
+- lib/generators/easy_contact/migration/templates/migration.rb
+- lib/tasks/easy_contact_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/yjchen/easy_contact
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A very simple contact system for Rails
+test_files: []