slack_messaging 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263c95f1178d714e3fea8e2531caa97e43532f9f
-  data.tar.gz: 882b3026e39ad6217d32876c7ce8ddb6b25d8d46
+  metadata.gz: d78f53c59095f17ce3bd0f2a19de2d1cd933cecf
+  data.tar.gz: f4cb1ea1c452a4a8f39e96fb1ee46bf58cf24f07
 SHA512:
-  metadata.gz: 8e903967552e5286684f052f79257daa7984fac87b989cc6d177278d1eafa4c7cefaaf8d31b042be85dce76eba51063f757ef5ca73f1677d5d1c4190e37e680f
-  data.tar.gz: 0619d2d30f69863832ec222187fae8da237207ff76c398965eb016ed6d65cc66e088bc7a771735a8ab57059e6894ece6b5aa0f070f2bd287a444e58024e6b236
+  metadata.gz: 315fe8c28b86d74563ce09ea49662df5e0e2ca050b242398a59c221c964e7c48de2277315f0e12b4fcecd0e984eb2b4cf57c107e51532c14564f1ef8be156bbd
+  data.tar.gz: dcd20a21275cc88abb808c2581bb08f9f591b5e00f401dc6ddf1fc81f1b11131f8c883cc691494aabeefffaf632e7bc55492cd449ed668caaa2d1733e12c4aef

data/CHANGELOG.markdown

@@ -1,3 +1,6 @@
+#### v1.1.0
+* Updating config.rb with more up to date information
+
 #### v1.0.1
 * Adding back in Changelog
 

data/README.md

@@ -2,16 +2,25 @@
 
 This is a simple project designed to post messages to a given Slack channel as a bot.
 
-### Usage
+## Installation
 
-First, run:
+Add this line to your application's Gemfile:
 
+```ruby
+gem 'slack_messaging'
 ```
-gem install bundler
-bundle install
-```
 
-Then, the project should be ready to go! However, it won't necessarily know where to print to Slack. So, this project requires a config file called `~/.slack_messaging.yml`. The config file should look like this:
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_messaging
+
+### Usage
+
+This project requires a config file that should look like this:
 
 ```
 slack:
@@ -21,9 +30,13 @@ slack:
   icon_emoji: ":[SOME EMOJI]:"
 ```
 
+The default is for the file to be named `~/.slack_messaging.yml`, but a different path can be passed in like this:
+
+    $ slack-messaging --config="/PATH/TO/FILE/config.yml" slack
+
 To obtain the webhook url, go to [this link](https://api.slack.com/incoming-webhooks).
 
-Okay, now the project will _actually_ be ready to rock and roll.
+Okay, now the project will be ready to rock and roll.
 
 To print a friendly message to Slack, run:
 
@@ -62,3 +75,18 @@ To contribute:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### RubyGems
+To make a new version and push to RubyGems:
+
+1. Update the CHANGELOG.markdown with the new version and changes made
+
+3. Run `git add -A && git commit -m "Updating Changelog for [version number]"`
+
+2. Update `lib/slack_messaging/version.rb` with the new version number
+
+4. Run `git add -A && git commit -m "Version Bump" && git push`
+
+5. Run `gem build slack_messaging.gemspec && gem push *.gem`
+
+6. Run `rm *.gem`

data/lib/slack_messaging/config.rb

@@ -1,14 +1,8 @@
 require 'yaml'
+require 'hashie'
 
 module SlackMessaging
 
-  module PrivateAttrAccessor
-    def private_attr_accessor(*names)
-      private
-      attr_accessor *names
-    end
-  end
-
   class DefaultPaths
     class << self
       def config
@@ -22,15 +16,10 @@ module SlackMessaging
   end
 
   class Config
-
-    CONFIG_DEFAULTS = {}
-
     class << self
-      extend PrivateAttrAccessor
-      private_attr_accessor :config_data
 
       def config
-        CONFIG_DEFAULTS.merge data
+        config_data.to_hash
       end
 
       def load(path)
@@ -38,54 +27,22 @@ module SlackMessaging
         config
       end
 
-      def set_config_options(opts = {})
-        data.merge! opts
-        config
+      def config_data
+        @config_data ||= Hashie::Mash.new
       end
-
-      def data
-        self.config_data ||= {}
-      end
-      private :data
-
-      def default_value(key)
-        CONFIG_DEFAULTS[key.to_sym]
-      end
-      private :default_value
+      private :config_data
 
       def method_missing(method, args=false)
-        return data[method] if data[method]
-        return default_value(method) if default_value(method)
-        nil
+        config_data.send(method, args)
       end
       private :method_missing
 
       def load_config(file)
         raise MissingConfig, "Missing configuration file: #{file}" unless File.exist?(file)
-        self.config_data = symbolize_keys(YAML.load_file(file)) rescue {}
+        YAML.load_file(file).each{ |key,value| config_data.assign_property(key, value) }
       end
       private :load_config
 
-      # We want all ouf our YAML loaded keys to be symbols
-      # taken from http://devblog.avdi.org/2009/07/14/recursively-symbolize-keys/
-      def symbolize_keys(hash)
-        hash.inject({}){|result, (key, value)|
-          new_key = case key
-                      when String then key.to_sym
-                      else key
-                    end
-          new_value = case value
-                        when Hash then symbolize_keys(value)
-                        else value
-                      end
-          result[new_key] = new_value
-          result
-        }
-      end
-      private :symbolize_keys
-
     end
-
-    MissingConfig = Class.new(StandardError)
   end
 end

data/lib/slack_messaging/version.rb

@@ -1,3 +1,3 @@
 module SlackMessaging
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/slack_messaging/config_spec.rb

@@ -4,32 +4,13 @@ require 'slack_messaging'
 module SlackMessaging
   describe Config do
 
-    context "#set_config_options" do
-      it "should create a corresponding method that returns the value" do
-        SlackMessaging::Config.set_config_options(test: "something")
-        expect(SlackMessaging::Config.test).to eql("something")
-      end
-
-      it "setting a new key should return the entire config hash" do
-        items = SlackMessaging::Config.config.count
-        expect(SlackMessaging::Config.set_config_options(test1: "something_else").count).to eql(items + 1)
-        expect(SlackMessaging::Config.set_config_options(test2: "something else").count).to eql(items + 2)
-      end
-    end
-
-    context "#config_data" do
-      it "should be a private method" do
-        expect(SlackMessaging::Config).not_to respond_to(:config_data)
-      end
-    end
-
     context "config key methods" do
       it "should return nil when not set" do
         expect(SlackMessaging::Config.doesnt_exist).to eql(nil)
+        expect(SlackMessaging::Config.doesnt_exist?).to eql(false)
       end
-
       it "should return the config value when set" do
-        SlackMessaging::Config.set_config_options(new_value: "testing")
+        SlackMessaging::Config.new_value = "testing"
         expect(SlackMessaging::Config.new_value).to eql("testing")
       end
     end
@@ -37,7 +18,7 @@ module SlackMessaging
     context "after loading a config file" do
       before do
         config_file = {"domain" => "example_domain",
-                       "slack" => {"slack_option"=>true,
+                       "slack" => {"slack_option" => true,
                                    "username" => "Rspec Tester",
                                    "icon_url" => "http://fake.url",
                                    "channel" => "#test-channel",
@@ -55,7 +36,7 @@ module SlackMessaging
 
       it "overwriting values should work" do
         expect(SlackMessaging::Config.slack).to be_kind_of(Hash)
-        SlackMessaging::Config.set_config_options(slack: "this is a string now")
+        SlackMessaging::Config.slack = "this is a string now"
         expect(SlackMessaging::Config.slack).to eql("this is a string now")
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack_messaging
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Emma Sax