comufy 0.0.2.pre2 → 0.0.3pre1

data/README.md

@@ -6,7 +6,7 @@ This library allows customers to interact with the Comufy backend and perform co
 
 Add this line to your application's Gemfile:
 
-    gem 'comufyruby'
+    gem 'comufy'
 
 And then execute:
 
@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install comufyruby
+    $ gem install comufy
 
 ## Usage
 

data/example/comufy_example.rb

@@ -1,12 +1,10 @@
 require 'comufy'
 
-USERNAME = ARGV[0]
-PASSWORD = ARGV[1]
-APPLICATION_NAME = ARGV[2]
-FACEBOOK_USER_ID = ARGV[3]
+APPLICATION_NAME  = ARGV[2]
+FACEBOOK_USER_ID  = ARGV[3]
 
-connect = Comufy.connect(logger: "debug", username: USERNAME, password: PASSWORD)
-tag = Array[{name: :other_details, type: Comufy::Connector::STRING_TYPE}]
+connect = Comufy.new(logger: ARGV[0], yaml: ARGV[1])
+tag = Array[{name: :other_details, type: Comufy::Constants::STRING_TYPE}]
 puts connect.register_tags(APPLICATION_NAME, tag)
 
 # register a tag!

data/lib/comufy/config.rb

@@ -1,46 +1,33 @@
-module Comufy
+class Comufy
   class Config
-    include Comufy
 
     attr_reader :user, :password, :base_api_url
     attr_accessor :access_token, :expiry_time
 
     # Sets the environment settings for Comufy to send and receive messages.
-    # @param [Hash] params - all are optional
-    #   [Object] staging - as long as this is a value other than false/nil it'll change the @base_api_url to 'staging'
-    #   [String] username - sets the username
-    #   [String] password - sets the password
-    #   [Object] no_env - as long as this is a value other than false/nil it'll not use environment values
-    def initialize params = {}
-      params = symbolize_keys(params)
+    # @param [Hash] opts - all are optional
+    #   [String]  username - sets the username
+    #   [String]  password - sets the password
+    #   [String]  token    - sets the access token
+    #   [String]  time     - sets the expiry time
+    #   [String]  url      - sets the url
+    #   [String]  yaml     - the absolute path to the yaml file to read, all previously mentioned options are valid
+    def initialize opts = {}
+      opts = Comufy.symbolize_keys(opts)
 
       begin
-        yaml_location = params[:yaml] || File.join(File.dirname(__FILE__), "yaml/config.yaml")
-        yaml = YAML.load_file(yaml_location)
-        yaml = symbolize_keys(yaml)
+        yaml_location = opts.delete(:yaml)
+        yaml          = YAML.load_file(yaml_location)
+        yaml          = Comufy.symbolize_keys(yaml)
       rescue
-        # TODO: should it check the ENV for the username and password?
         yaml = Hash.new()
       end
 
-      user = params[:user]
-      password = params[:password]
-      no_env = params[:no_env]
-      staging = params[:staging]
-
-      if (user and not password) or (password and not user)
-        raise "You must supply both a username and password."
-      end
-
-      @user = user || yaml.fetch(:config, {})['user']
-      @password = password || yaml.fetch(:config, {})['password']
-      @access_token = no_env ? nil : ENV.fetch('access_token',  nil)
-      @expiry_time = no_env ? nil : ENV.fetch('expiry_time',   nil)
-
-      staging ?
-          @base_api_url = 'https://staging.comufy.com/xcoreweb/client' :
-          @base_api_url = 'https://social.comufy.com/xcoreweb/client'
-
+      @user         = yaml.delete(:user)      || opts.delete(:user)     || ENV.fetch('COMUFY_USER',         nil)
+      @password     = yaml.delete(:password)  || opts.delete(:password) || ENV.fetch('COMUFY_PASSWORD',     nil)
+      @access_token = yaml.delete(:token)     || opts.delete(:token)    || ENV.fetch('COMUFY_TOKEN',        nil)
+      @expiry_time  = yaml.delete(:time)      || opts.delete(:time)     || ENV.fetch('COMUFY_EXPIRY_TIME',  nil)
+      @base_api_url = yaml.delete(:url)       || opts.delete(:url)      || ENV.fetch('COMUFY_URL',          'http://www.sociableapi.com/xcoreweb/client')
     end
   end
 end

data/lib/comufy/constants.rb

@@ -0,0 +1,15 @@
+class Comufy::Constants
+
+  # values types for TYPE_TAG
+  STRING_TYPE = :STRING
+  DATE_TYPE   = :DATE
+  GENDER_TYPE = :GENDER
+  INT_TYPE    = :INT
+  FLOAT_TYPE  = :FLOAT
+  LEGAL_TYPES = [STRING_TYPE, DATE_TYPE, GENDER_TYPE, INT_TYPE, FLOAT_TYPE]
+
+  # key choices for tags
+  NAME_TAG    = :name
+  TYPE_TAG    = :type
+  LEGAL_TAGS  = [NAME_TAG, TYPE_TAG]
+end

data/lib/comufy/version.rb

@@ -1,3 +1,3 @@
-module Comufy
-  VERSION = "0.0.2.pre2"
+class Comufy
+  VERSION = "0.0.3pre1"
 end