metaforce 0.3.0.alpha → 0.3.1

data/README.md

@@ -4,12 +4,9 @@
 Metaforce is a Ruby gem for interacting with the [Salesforce Metadata API](http://www.salesforce.com/us/developer/docs/api_meta/index.htm).
 The goal of this project is to make the [Migration Tool](http://www.salesforce.com/us/developer/docs/apexcode/Content/apex_deploying_ant.htm) obsolete, favoring Rake over Ant.
 
-**Metaforce is in active development and is currently in alpha status. Don't use
-it to deploy code to production instances. You've been warned!**
-
 ## Installation
 ```bash
-gem install metaforce --pre
+gem install metaforce
 ```
 
 ## Usage
@@ -64,9 +61,10 @@ end
 This gem is far from being feature complete. Here's a list of things that still
 need to be done.
 
-* <del>Implement .retrieve for retrieving metadata.</del>
 * Implement CRUD based calls <http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_crud_based_calls_intro.htm>.
 * Implement some helper methods for diffing metadata.
+* Ability to deploy directly from a git repository.
+* <del>Implement .retrieve for retrieving metadata.</del>
 * <del>Implement a DSL.</del>
 * And some other stuff that I haven't quite thought of yet...
 
@@ -76,6 +74,12 @@ feature on a new branch, then send me a pull request with a detailed
 description. Please provide applicable rspec specs.
 
 ## Version History
+**0.3.1** (February 3, 2012)
+
+* Dynamically defined helper methods for .list (e.g. `client.list_apex_classes`, `client.list_custom_objects`).
+* The `describe` method now caches the results to minimize latency. `describe!`
+  can be used to force a refresh.
+
 **0.3.0.alpha** (January 29, 2012)
 
 * Ability to retrieve metadata from an organization.

data/lib/metaforce/api/metadata.rb

@@ -49,12 +49,29 @@ module Metaforce
         response.body[:list_metadata_response][:result]
       end
 
-      # Describe the organization's metadata
+      # Defines some helper methods for listing metadata types
+      #
+      # Example
+      #  
+      #   client.list_apex_classes
+      #   client.list_custom_objects
+      METADATA_TYPES.each do |type, value|
+        define_method("list_#{value[:plural]}".to_sym) do
+          list :type => value[:name]
+        end
+      end
+
+      # Describe the organization's metadata and cache the response
       def describe
+        @describe ||= describe!
+      end
+
+      # Describe the organization's metadata
+      def describe!
         response = @client.request(:describe_metadata) do |soap|
           soap.header = @header
         end
-        response.body[:describe_metadata_response][:result]
+        @describe = response.body[:describe_metadata_response][:result]
       end
 
       # Checks the status of an async result

data/lib/metaforce/manifest.rb

@@ -1,4 +1,5 @@
 require 'nokogiri'
+require 'metaforce/types'
 
 module Metaforce
   class Manifest
@@ -101,17 +102,17 @@ module Metaforce
 
     # Returns the components name
     def component_name(key) # :nodoc:
-      COMPONENT_TYPE_MAP[key][:name]
+      METADATA_TYPES[key][:name]
     end
 
     # Returns the components folder
     def component_folder(key) # :nodoc:
-      COMPONENT_TYPE_MAP[key][:folder]
+      METADATA_TYPES[key][:folder]
     end
 
     # Returns a key for the component name
     def component_key(name) # :nodoc:
-      COMPONENT_TYPE_MAP.each do |key, component|
+      METADATA_TYPES.each do |key, component|
         return key if component[:name] == name
       end
     end
@@ -172,10 +173,7 @@ module Metaforce
       components = []
       @components.each do |type, members|
         name = component_name(type)
-        components.push({
-          :members => members,
-          :name => name
-        })
+        components.push :members => members, :name => name
       end
       components
     end
@@ -197,175 +195,5 @@ module Metaforce
       self
     end
 
-    COMPONENT_TYPE_MAP = {
-      :action_override => {
-        :name => "ActionOverride",
-        :folder => "objects"
-      },
-      :analytics_snapshot => {
-        :name => "AnalyticsSnapshot",
-        :folder => "analyticsnapshots"
-      },
-      :apex_class => {
-        :name => "ApexClass",
-        :folder => "classes"
-      },
-      :article_type => {
-        :name => "ArticleType",
-        :folder => "objects"
-      },
-      :apex_component => {
-        :name => "ApexComponent",
-        :folder => "components"
-      },
-      :apex_page => {
-        :name => "ApexPage",
-        :folder => "pages"
-      },
-      :apex_trigger => {
-        :name => "ApexTrigger",
-        :folder => "triggers"
-      },
-      :business_process => {
-        :name => "BusinessProcess",
-        :folder => "objects"
-      },
-      :custom_application => {
-        :name => "CustomApplication",
-        :folder => "applications"
-      },
-      :custom_field => {
-        :name => "CustomField",
-        :folder => "objects"
-      },
-      :custom_labels => {
-        :name => "CustomLabels",
-        :folder => "labels"
-      },
-      :custom_object => {
-        :name => "CustomObject",
-        :folder => "objects"
-      },
-      :custom_object_translation => {
-        :name => "CustomObjectTranslation",
-        :folder => "objectTranslations"
-      },
-      :custom_page_web_link => {
-        :name => "CustomPageWebLink",
-        :folder => "weblinks"
-      },
-      :custom_site => {
-        :name => "CustomSite",
-        :folder => "sites"
-      },
-      :custom_tab => {
-        :name => "CustomTab",
-        :folder => "tabs"
-      },
-      :dashboard => {
-        :name => "Dashboard",
-        :folder => "dashboards"
-      },
-      :data_category_group => {
-        :name => "DataCategoryGroup",
-        :folder => "datacategorygroups"
-      },
-      :document => {
-        :name => "Document",
-        :folder => "document"
-      },
-      :email_template => {
-        :name => "EmailTemplate",
-        :folder => "email"
-      },
-      :entitlement_template => {
-        :name => "EntitlementTemplate",
-        :folder => "entitlementTemplates"
-      },
-      :field_set => {
-        :name => "FieldSet",
-        :folder => "objects"
-      },
-      :home_page_component => {
-        :name => "HomePageComponent",
-        :folder => "homePageComponents"
-      },
-      :layout => {
-        :name => "Layout",
-        :folder => "layouts"
-      },
-      :letterhead => {
-        :name => "Letterhead",
-        :folder => "letterhead"
-      },
-      :list_view => {
-        :name => "ListView",
-        :folder => "objects"
-      },
-      :named_filter => {
-        :name => "NamedFilter",
-        :folder => "objects"
-      },
-      :permission_set => {
-        :name => "PermissionSet",
-        :folder => "permissionsets"
-      },
-      :portal => {
-        :name => "Portal",
-        :folder => "portals"
-      },
-      :profile => {
-        :name => "Profile",
-        :folder => "profiles"
-      },
-      :record_type => {
-        :name => "RecordType",
-        :folder => "objects"
-      },
-      :remote_site_setting => {
-        :name => "RemoteSiteSetting",
-        :folder => "remoteSiteSettings"
-      },
-      :report => {
-        :name => "Report",
-        :folder => "reports"
-      },
-      :report_type => {
-        :name => "ReportType",
-        :folder => "reportTypes"
-      },
-      :scontroler => {
-        :name => "Scontroler",
-        :folder => "scontrols"
-      },
-      :sharing_reason => {
-        :name => "SharingReason",
-        :folder => "objects"
-      },
-      :sharing_recalculation => {
-        :name => "SharingRecalculation",
-        :folder => "objects"
-      },
-      :static_resource => {
-        :name => "StaticResource",
-        :folder => "staticResources"
-      },
-      :translations => {
-        :name => "Translations",
-        :folder => "translations"
-      },
-      :validation_rule => {
-        :name => "ValidationRule",
-        :folder => "objects"
-      },
-      :weblink => {
-        :name => "Weblink",
-        :folder => "objects"
-      },
-      :workflow => {
-        :name => "Workflow",
-        :folder => "workflows"
-      }
-    }
   end
 end

data/lib/metaforce/types.rb

@@ -0,0 +1,214 @@
+module Metaforce
+  METADATA_TYPES = {
+    :action_override => {
+      :name => "ActionOverride",
+      :folder => "objects",
+      :plural => :action_overrides
+    },
+    :analytics_snapshot => {
+      :name => "AnalyticsSnapshot",
+      :folder => "analyticsnapshots",
+      :plural => :analytics_snapshots
+    },
+    :apex_class => {
+      :name => "ApexClass",
+      :folder => "classes",
+      :plural => :apex_classes
+    },
+    :article_type => {
+      :name => "ArticleType",
+      :folder => "objects",
+      :plural => :article_types
+    },
+    :apex_component => {
+      :name => "ApexComponent",
+      :folder => "components",
+      :plural => :apex_components
+    },
+    :apex_page => {
+      :name => "ApexPage",
+      :folder => "pages",
+      :plural => :apex_pages
+    },
+    :apex_trigger => {
+      :name => "ApexTrigger",
+      :folder => "triggers",
+      :plural => :apex_triggers
+    },
+    :business_process => {
+      :name => "BusinessProcess",
+      :folder => "objects",
+      :plural => :business_processes
+    },
+    :custom_application => {
+      :name => "CustomApplication",
+      :folder => "applications",
+      :plural => :custom_applications
+    },
+    :custom_field => {
+      :name => "CustomField",
+      :folder => "objects",
+      :plural => :custom_fields
+    },
+    :custom_labels => {
+      :name => "CustomLabels",
+      :folder => "labels",
+      :plural => :custom_labels
+    },
+    :custom_object => {
+      :name => "CustomObject",
+      :folder => "objects",
+      :plural => :custom_objects
+    },
+    :custom_object_translation => {
+      :name => "CustomObjectTranslation",
+      :folder => "objectTranslations",
+      :plural => :custom_object_translations
+    },
+    :custom_page_web_link => {
+      :name => "CustomPageWebLink",
+      :folder => "weblinks",
+      :plural => :custom_page_web_links
+    },
+    :custom_site => {
+      :name => "CustomSite",
+      :folder => "sites",
+      :plural => :custom_sites
+    },
+    :custom_tab => {
+      :name => "CustomTab",
+      :folder => "tabs",
+      :plural => :custom_tabs
+    },
+    :dashboard => {
+      :name => "Dashboard",
+      :folder => "dashboards",
+      :plural => :dashboards
+    },
+    :data_category_group => {
+      :name => "DataCategoryGroup",
+      :folder => "datacategorygroups",
+      :plural => :data_category_groups
+    },
+    :document => {
+      :name => "Document",
+      :folder => "document",
+      :plural => :documents
+    },
+    :email_template => {
+      :name => "EmailTemplate",
+      :folder => "email",
+      :plural => :email_templates
+    },
+    :entitlement_template => {
+      :name => "EntitlementTemplate",
+      :folder => "entitlementTemplates",
+      :plural => :entitlement_templates
+    },
+    :field_set => {
+      :name => "FieldSet",
+      :folder => "objects",
+      :plural => :field_sets
+    },
+    :home_page_component => {
+      :name => "HomePageComponent",
+      :folder => "homePageComponents",
+      :plural => :home_page_components
+    },
+    :layout => {
+      :name => "Layout",
+      :folder => "layouts",
+      :plural => :layouts
+    },
+    :letterhead => {
+      :name => "Letterhead",
+      :folder => "letterhead",
+      :plural => :letterheads
+    },
+    :list_view => {
+      :name => "ListView",
+      :folder => "objects",
+      :plural => :list_views
+    },
+    :named_filter => {
+      :name => "NamedFilter",
+      :folder => "objects",
+      :plural => :named_filters
+    },
+    :permission_set => {
+      :name => "PermissionSet",
+      :folder => "permissionsets",
+      :plural => :permission_sets
+    },
+    :portal => {
+      :name => "Portal",
+      :folder => "portals",
+      :plural => :portals
+    },
+    :profile => {
+      :name => "Profile",
+      :folder => "profiles",
+      :plural => :profiles
+    },
+    :record_type => {
+      :name => "RecordType",
+      :folder => "objects",
+      :plural => :record_types
+    },
+    :remote_site_setting => {
+      :name => "RemoteSiteSetting",
+      :folder => "remoteSiteSettings",
+      :plural => :remote_site_settings
+    },
+    :report => {
+      :name => "Report",
+      :folder => "reports",
+      :plural => :reports
+    },
+    :report_type => {
+      :name => "ReportType",
+      :folder => "reportTypes",
+      :plural => :report_types
+    },
+    :scontroler => {
+      :name => "Scontroler",
+      :folder => "scontrols",
+      :plural => :scontrolers
+    },
+    :sharing_reason => {
+      :name => "SharingReason",
+      :folder => "objects",
+      :plural => :sharing_reasons
+    },
+    :sharing_recalculation => {
+      :name => "SharingRecalculation",
+      :folder => "objects",
+      :plural => :sharing_recalculations
+    },
+    :static_resource => {
+      :name => "StaticResource",
+      :folder => "staticResources",
+      :plural => :static_resources
+    },
+    :translations => {
+      :name => "Translations",
+      :folder => "translations",
+      :plural => :translations
+    },
+    :validation_rule => {
+      :name => "ValidationRule",
+      :folder => "objects",
+      :plural => :validation_rules
+    },
+    :weblink => {
+      :name => "Weblink",
+      :folder => "objects",
+      :plural => :weblinks
+    },
+    :workflow => {
+      :name => "Workflow",
+      :folder => "workflows",
+      :plural => :workflows
+    }
+  }
+end

data/lib/metaforce/version.rb

@@ -1,3 +1,3 @@
 module Metaforce
-  VERSION = "0.3.0.alpha"
+  VERSION = "0.3.1"
 end

data/spec/lib/api/metadata_spec.rb

@@ -12,13 +12,17 @@ describe Metaforce::Metadata::Client do
   end
   
   describe ".list" do
-    context "when given valid information" do
 
-      it "returns an array" do
-        savon.expects(:list_metadata).with(:queries => [ :type => "ApexClass"]).returns(:objects)
-        client.list(:type => "ApexClass").should be_an(Array)
-      end
+    it "returns an array" do
+      savon.expects(:list_metadata).with(:queries => [ :type => "ApexClass"]).returns(:objects)
+      client.list(:type => "ApexClass").should be_an(Array)
+    end
 
+  end
+
+  it "should respond to dynamically defined list methods" do
+    Metaforce::METADATA_TYPES.each do |type, value|
+      client.respond_to?("list_#{value[:plural]}").should eq(true)
     end
   end
 
@@ -30,6 +34,30 @@ describe Metaforce::Metadata::Client do
         client.describe.should be_a(Hash)
       end
 
+      it "caches the response" do
+        savon.expects(:describe_metadata).returns(:success)
+        client.describe.should be_a(Hash)
+        expect { client.describe }.to_not raise_error
+      end
+
+    end
+  end
+
+  describe ".describe!" do
+    context "when given valid information" do
+
+      it "returns a hash" do
+        savon.expects(:describe_metadata).returns(:success)
+        client.describe!.should be_a(Hash)
+      end
+
+      it "doesn't cache the response" do
+        savon.expects(:describe_metadata).returns(:success)
+        client.describe!.should be_a(Hash)
+        savon.expects(:describe_metadata).returns(:success)
+        expect { client.describe! }.to_not raise_error
+      end
+
     end
   end
 

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: metaforce
 version: !ruby/object:Gem::Version
-  version: 0.3.0.alpha
-  prerelease: 6
+  version: 0.3.1
+  prerelease: 
 platform: ruby
 authors:
 - Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-30 00:00:00.000000000 Z
+date: 2012-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &3632840 !ruby/object:Gem::Requirement
+  requirement: &9206270 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *3632840
+  version_requirements: *9206270
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &3631640 !ruby/object:Gem::Requirement
+  requirement: &9187580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *3631640
+  version_requirements: *9187580
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &3630690 !ruby/object:Gem::Requirement
+  requirement: &9170720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *3630690
+  version_requirements: *9170720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &3629920 !ruby/object:Gem::Requirement
+  requirement: &9164330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *3629920
+  version_requirements: *9164330
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &3629280 !ruby/object:Gem::Requirement
+  requirement: &9145350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *3629280
+  version_requirements: *9145350
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &3627890 !ruby/object:Gem::Requirement
+  requirement: &9142060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *3627890
+  version_requirements: *9142060
 - !ruby/object:Gem::Dependency
   name: savon_spec
-  requirement: &3625600 !ruby/object:Gem::Requirement
+  requirement: &9115390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 0.1.6
   type: :development
   prerelease: false
-  version_requirements: *3625600
+  version_requirements: *9115390
 description: A Ruby gem for interacting with the Salesforce Metadata API
 email:
 - eric@ejholmes.net
@@ -109,6 +109,7 @@ files:
 - lib/metaforce/config.rb
 - lib/metaforce/dsl.rb
 - lib/metaforce/manifest.rb
+- lib/metaforce/types.rb
 - lib/metaforce/version.rb
 - metaforce.gemspec
 - spec/.gitignore
@@ -151,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: metaforce
 rubygems_version: 1.8.15