glass-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f0c58157a2668abbda0417296fcf8ac4f57a3a4
-  data.tar.gz: b7859dc9b8804a5c7c2f95a0fe27eb8cf236d852
+  metadata.gz: 04e2a6397d54f83f18ca0038cf0512ac36d5516c
+  data.tar.gz: 9294c8db7bf53009e9063a7907fce9522f434268
 SHA512:
-  metadata.gz: 6c51db88dae76a80f11a2ef3fcce707e8944f27ea615111872d939449ac09aa276175f21fc45514acc8bbc51ba13fc0aad28d42c961a67a74565e8917f7b4825
-  data.tar.gz: 92de4b4ca3572f44bc297ee6cb8a4f6063b2aa530d116b4a6b34af255b0cd490db6381bfeb3e656ec40dba835207f014897b859b02882ab8fe7633fb8c485cc5
+  metadata.gz: 16c3cce5db9c51886b515ecf47b2d2603c9c821d42f83f3e486258c5f921b5553b77e0ad94a979e9efd03040dad0a5490ee13804c146bde04070793befc99605
+  data.tar.gz: 6c02d1425142c574d5d18c88fb477d4a56cedbe682cda18f19f5cf0cc84aabd5d8072e7459d2d8295a7a2be6f35ff104cd0317f1948c5d23560816af9cd1bb25

data/.gitignore

@@ -5,6 +5,8 @@
 .config
 .yardoc
 .rspec
+.ruby-version
+.ruby-gemset
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -34,6 +34,23 @@ tables.
 Additionally, the install generator will create a set of html.erb templates for you to use (optionally) when creating timeline items to post to a user. The templates will be created under the directory
 `app/views/glass` though you may want to organize them more logically, depending on your use case.
 
+### API Key Configuration
+
+The glass install generator will automatically generate a yaml file for you in the correct format for storing your client id and client secret, for each respective environment. You can optionally bypass loading your API Keys from 
+a YAML file by utilizing the generated initializer, which allows you to set custom configurations for your application. 
+
+If you want to load your keys, for example, from your ENV variables, you can do so like this:
+
+```ruby
+Glass.setup do |config|
+
+  ## blah blah some config stuff..
+  
+  
+  config.client_id = ENV["GOOGLE_CLIENT_ID"]
+  config.client_secret = ENV["GOOGLE_CLIENT_SECRET"]
+end
+```
 ### Glass Models - (Introduction)
 
 This gem also provides a glass model generator, which generates a timeline-item
@@ -196,12 +213,12 @@ mirror api for insertion into the timeline.
 Then all you have to do is use the following command to actually insert the content:
 
 ```ruby
-gt.insert()
+gt.mirror_insert()
 ```
 
 Additionally, if you would like to merge in attributes into the hash before it is 
 posted to the mirror-api, then you can optionally pass in a hash of attributes 
-to the insert() method call, and the hash will be merged into the body_object that
+to the mirror_insert() method call, and the hash will be merged into the body_object that
 is posted to the mirror api.
 
 This last point is relevant, for example, in the case of reading aloud text. 
@@ -209,7 +226,7 @@ To do so, you need to specify a speakableText: "some text to be read aloud" attr
 in the body object when it gets posted. You can therefore do something like this:
 
 ```ruby
-gt.insert(speakableText: "some text to be read aloud")
+gt.mirror_insert(speakableText: "some text to be read aloud")
 ```
 ## License 
 

data/lib/generators/glass/install/templates/initializer.rb

@@ -9,13 +9,27 @@ Rails.application.routes.default_url_options[:host] = 'localhost:3000' if Rails.
 ## Your configuration details here:
 
 Glass.setup do |config|
-  ## modify this to change the name of your glass app
+
+  #  modify this to change the name of your glass app
   ## config.application_name = "SomeGlassApp"
 
-  ## modify this to change the application version of your glass app
+
+
+  #  modify this to change the application version of your glass app
   ## config.application_version = "0.0.1"
 
 
+
+  #  if you don't want to use a yaml file to load your api
+  #  keys, then you can use these config vars to force load
+  #  your keys from enviroment variables, or whatever method 
+  #  you might choose.
+  # 
+  ## config.client_id = ENV["GOOGLE_CLIENT_ID"]
+  ## config.client_secret = ENV["GOOGLE_CLIENT_SECRET"]
+
+
+
   ## manually override your glass views path here.
   config.glass_template_path = "app/views/glass"
 end

data/lib/glass.rb

@@ -15,10 +15,18 @@ module Glass
   mattr_accessor :glass_template_path
   @@glass_template_path = "app/views/glass" 
 
+  mattr_accessor :_api_keys
+  @@_api_keys = nil
 
+  mattr_accessor :client_id
+
+  mattr_accessor :client_secret
+  
   ## devise trick
   def self.setup
     yield self
+    require "glass/api_keys"
+    Glass::ApiKeys.generate!
   end
+end
 
-end

data/lib/glass/api_keys.rb

@@ -1,29 +1,68 @@
 require "yaml"
+require "pry"
 module Glass
   ## just a small class to organize the api key logic info
   ## from the yml file in config. 
   class ApiKeys
     class APIKeyConfigurationError < StandardError; end;
-    attr_accessor :client_id, :client_secret, :google_api_keys
+    class YAMLDoesNotHaveTheRightKeysForExtraction < StandardError; end;
+    attr_accessor :client_id, :client_secret, :google_api_keys, :yaml_config, :yaml_file_contents, :keys
     def initialize
-      self.google_api_keys = load_yaml_file
+      self.google_api_keys = {}
+      preload_yaml_file_keys
+      load_google_keys_from_whereever
       load_keys
-      self
+      return self.keys
+    end
+    def self.generate!
+      keys_instance = self.new
+      keys_instance.keys
+      ::Glass.client_secret = keys_instance.keys.client_secret
+      ::Glass.client_id = keys_instance.keys.client_id
+      ::Glass._api_keys = keys_instance.keys
+    end
+  private
+    def yaml_file_path
+      "#{Dir.pwd}/config/google-api-keys.yml"
     end
-    private
     def load_keys
-      if google_api_keys["client_id"].nil? or google_api_keys["client_secret"].nil?
-        raise APIKeyConfigurationError
-      else
-        set_client_keys
+      google_api_keys_are_empty? ? (raise APIKeyConfigurationError) : set_client_keys
+    end
+    def yaml_config_hash
+      return self.yaml_file_contents if self.yaml_file_contents
+      self.yaml_file_contents = {}
+      self.yaml_file_contents = ::YAML.load(File.read(yaml_file_path)) if File.exists?(yaml_file_path)
+      self.yaml_file_contents
+    end
+    def preload_yaml_file_keys
+      self.yaml_config = {}
+      if yaml_config_hash.has_key?(::Rails.env)
+        self.yaml_config = yaml_config_hash[::Rails.env] 
       end
     end
-    def load_yaml_file
-      ::YAML.load(File.read("#{::Rails.root}/config/google-api-keys.yml"))[::Rails.env]
+
+    def load_google_keys_from_whereever 
+      [:client_id, :client_secret].each do |key|
+        google_api_keys[key] = ::Glass.send(key) 
+        unless google_api_keys[key]
+          load_yaml_as_auxiliary_method(key)
+        end
+      end
+    end
+
+    def load_yaml_as_auxiliary_method(key)
+      if yaml_config.has_key?(key.to_s)
+        google_api_keys[key] = yaml_config[key.to_s] 
+      else
+        raise YAMLDoesNotHaveTheRightKeysForExtraction
+      end
     end
     def set_client_keys
-      self.client_id = google_api_keys["client_id"]
-      self.client_secret = google_api_keys["client_secret"]
+      keys_struct = Struct.new(:client_id, :client_secret)
+      self.keys = keys_struct.new(google_api_keys[:client_id], google_api_keys[:client_secret])
+    end
+    def google_api_keys_are_empty?
+      google_api_keys[:client_id].nil? or google_api_keys[:client_secret].nil?
     end
   end
-end
+end

data/lib/glass/client.rb

@@ -1,4 +1,3 @@
-require "glass/api_keys"
 require 'active_support/core_ext/hash/indifferent_access'
 require "google/api_client"
 
@@ -16,36 +15,18 @@ module Glass
     end
 
     def initialize(opts)
-      self.api_keys = opts[:api_keys] || ::Glass::ApiKeys.new
-      initialize_google_api_client
-      self.mirror_api = google_client.discovered_api("mirror", "v1")
+      setup_google_api_keys
+      initialize_google_client
       self.google_account = opts[:google_account]
-
-      ### this isn't functional yet but this is an idea for
-      ### an api for those who wish to opt out of passing in a
-      ### google account, by passing in a hash of options
-      ###
-      ###
-      ### the tricky aspect of this is how to handle the update
-      ### of the token information if the token is expired.
-
-      self.access_token = opts[:access_token] || google_account.try(:token)
-      self.refresh_token = opts[:refresh_token] || google_account.try(:refresh_token)
-      self.has_expired_token = opts[:has_expired_token] || google_account.has_expired_token?
-
       setup_with_our_access_tokens
       setup_with_user_access_token
       self
     end
-    def initialize_google_api_client
-      application_name = ::Glass.application_name
-      application_version = ::Glass.application_version
-      self.google_client = ::Google::APIClient.new(application_name: application_name, application_version: application_version)
-    end
 
     def get_timeline_item(id)
       response_hash(self.google_client.execute(get_timeline_item_parameters(id)).response)
     end
+
     def get_timeline_item_parameters(id)
       { api_method: self.mirror_api.timeline.get,
         parameters: {
@@ -59,7 +40,6 @@ module Glass
       self
     end
 
-
     def json_content(options, api_method="insert")
       if c = options[:content]
         data = c.is_a?(String) ? {text: c} : c
@@ -82,6 +62,7 @@ module Glass
       inserting_content = { api_method: mirror_api.timeline.send(action),
                             body_object: body_object}
     end
+
     def get(id)
       self.google_client.execute(get_timeline_item_parameters(id))
     end
@@ -90,7 +71,6 @@ module Glass
       google_client.execute(rest_action(options, "insert"))
     end
 
-
     def patch(options={})
       glass_item_id = options.delete(:glass_item_id)
       patch_action = rest_action(options, "patch").merge(parameters: {id: glass_item_id})
@@ -106,15 +86,12 @@ module Glass
       google_client.execute update_content
     end
 
-
-
     ## deprecated: please use cached_list instead
     def timeline_list(opts={as_hash: true})
       puts "DEPRECATION WARNING: timeline_list is now deprecated, please use cached_list instead"
       cached_list
     end
 
-
     def cached_list(opts={as_hash: true})
       retval = @timeline_list.nil? ? self.list(opts) : @timeline_list
       opts[:as_hash] ? retval.map(&:to_hash).map(&:with_indifferent_access) : retval
@@ -151,16 +128,12 @@ module Glass
       timeline_list(opts)
     end
 
-
-
-
     def delete(options={})
       deleting_content = { api_method: mirror_api.timeline.delete,
                            parameters: options }
       google_client.execute(deleting_content)
     end
 
-
     def response_hash(google_response)
       JSON.parse(google_response.body).with_indifferent_access
     end
@@ -194,8 +167,6 @@ module Glass
       ea_data_hash
     end
 
-
-    private
     def format_hash_properly(data_hash)
       data_hash.inject({}) do |acc, (key, value)|
         new_key = key.to_s.camelize(:lower)
@@ -203,11 +174,25 @@ module Glass
         acc
       end.with_indifferent_access
     end
+
     def to_google_time(time)
       Time.now.to_i + time
     end
+
     def format_date(time)
       time.to_time.utc.iso8601.gsub("Z", ".000Z") # fucking google has a weird format
     end
+
+    def initialize_google_client
+      application_name = ::Glass.application_name
+      application_version = ::Glass.application_versio
+      self.google_client = ::Google::APIClient.new(application_name: application_name, 
+                                                   application_version: application_version)
+      self.mirror_api = google_client.discovered_api("mirror", "v1")
+    end
+
+    def setup_google_api_keys
+      self.api_keys = ::Glass._api_keys
+    end
   end
 end

data/lib/glass/rails/version.rb

@@ -1,5 +1,5 @@
 module Glass
   module Rails
-    VERSION="1.0.0"
+    VERSION="1.0.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glass-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kunal Modi