iris_rails 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df0c03c62172f9afad270b4993a2d74d526bfdb8f472365b4c8bfebac261bb5
-  data.tar.gz: e71e30515913579868fa114e3a69cd7555b9f6bd0a1dae3e66f879c4c0219eb4
+  metadata.gz: a73671f6aac8f0da411ff5bbda15d41e279a8a32e9b82f1efbe7dc4ed71fd0f6
+  data.tar.gz: 46e3ead0ed312e11d6c23960718937df7fe9310701f68f8acc5731caa5cfeecd
 SHA512:
-  metadata.gz: be35175aa33470983499c8fea98e1bc343515368152d8d8b8a35060e98f1133f55b2b853d7c95e0d47212cc658271112c589046290e8874ea8948bd7302743c5
-  data.tar.gz: 5e0a360077e625f1ca2e25950d3e2cf73469e5f59f478c1b3ff73b083541edfed135947d84c633f93be6514a3f4002f1913ec1c6cb5604038f232ac1e8c38bfb
+  metadata.gz: c6eef5aa751e58609a23f9d69b1993725531d01e0fec6f66a98169de38efe08c8ddb8520f36754f9a3416511fea7bfdebcd144269811f811faff050a99e3ec11
+  data.tar.gz: f46d33786a3aeb6a66a68d59cf7b6a896b1de1b6c3d701733058df7948b97decda0bc8497bdefc005a10ba01ac3866ab163b7677eecae09c187571e9441cc391

data/README.md

@@ -9,32 +9,83 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'iris-rails'
+gem 'iris_rails'
 ```
 
 And then execute:
 
+```ruby
     $ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install iris
+```ruby
+    $ gem install iris_rails
+```
 
 ## Usage
 
-Or install it yourself as:
+After installing, run the genereator provided by the gem:
+
+```ruby
+rails generate iris:install 
+```
+
+The generator creates an initializer file and default controllers and views:
+
+```
+|-- app
+    |-- controllers
+        |-- iris_rails
+            |-- base_controller.rb
+            |-- posts_controller.rb
+    |-- views
+        |-- iris_rails
+            |-- posts
+                |-- index.html.erb
+                |-- show.html.erb
+    |-- helpers
+        |-- meta_tags_helper.rb
+
+|-- config
+    |-- initializers
+        |-- iris_rails.rb
+|-- lib
+    |-- iris_rails.rb
+```
+
+It also adds routes to your `routes.rb`  file:
+
+```ruby
+    scope :module => 'iris_rails' do
+      get '/blog' => 'posts#index', :as => :iris_blog
+      get '/blog/:slug' => 'posts#show', :as => :iris_post
+    end
+```
+
+After running the generator, set your API token in `config/initializers/iris_rails.rb`
 
-    $ rails install:iris-rails
+## Customization
 
-## Development
+Extending and customizing your blog is easy.
+
+Define in `app/controllers/iris_rails/base_controller.rb` the layout you will use. If you have some verifications the page, make sure to copy them to IrisRails::BaseController.
+
+Iris_Rails uses a helper method to define title, meta tags (meta title, meta description and meta keywords) and use CSS with the template defined in iris website (iriseo.com). Make sure you select the template in iris.com/settings so your blog has a nice look! Add the lines below to the layout you will use and and set title and meta tags of your website.
+
+```ruby
+iris_meta_tags(head_title: 'INSERT_WEBSITE_TITLE', meta_description: 'INSERT_WEBSITE_META_DESCRIPTION', meta_keywords: 'INSERT_WEBSITE_META_KEYWORDS', meta_author: 'INSERT_WEBSITE_META_AUTHOR')
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Insert your website title in INSERT_WEBSITE_TITLE, meta_description in INSERT_WEBSITE_META_DESCRIPTION, meta_keywords in INSERT_WEBSITE_META_KEYWORDS and meta_author in INSERT_WEBSITE_META_AUTHOR. Don't create a tag with these attributes if you are using the method iris_meta_tags because duplicated attributes lower the SEO score. If you don't have these attributes, just leave it as a whitespace.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Now start your server and to view your blog just access YOUR_URL/blog.
+Reminder, you have to add posts to your blog in Iris website www.iriseo.com.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iris. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/horta-tech/iris-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -42,4 +93,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Iris project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/iris/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Iris project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/horta-tech/iris-rails/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require "bundler/setup"
 require "iris"
 

data/{iris.gemspec → iris_rails.gemspec}

@@ -28,7 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rest-client", "~> 2.1.0"
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.2"
-end
+end

data/lib/generators/iris/install_generator.rb

@@ -17,7 +17,10 @@ module Iris
         directory "app/views/iris_rails", "app/views/iris_rails"
 
         # Create helper
-        directory "app/helpers/meta_tags_helper", "app/helpers/meta_tags_helper"
+        copy_file "app/helpers/meta_tags_helper.rb", "app/helpers/meta_tags_helper.rb"
+
+        # Create iris_rails model
+        copy_file "../lib/iris_rails.rb", "lib/iris_rails.rb"
 
         # Create default layout
         # directory "app/views/layouts/iris", "app/views/layouts/iris"

data/lib/generators/templates/app/controllers/iris_rails/base_controller.rb

@@ -1,4 +1,5 @@
 class IrisRails::BaseController < ActionController::Base
   # If you want, you can set a different layout for your blog here
-  # layout 'example'
+  layout 'application'
+  # Add your verifications here if your layout uses any
 end

data/lib/generators/templates/app/controllers/iris_rails/posts_controller.rb

@@ -6,20 +6,31 @@ class IrisRails::PostsController < IrisRails::BaseController
     @first_posts = @posts.first(3)
     @highlighted_posts = @posts[3, 3]
     @more_posts = @posts[6, @posts.size - (@posts.length.odd? ? 9 : 6)]
-    @last_posts = @posts.length.odd? ? @posts.last(3) : []
+    if @posts.length.odd? && (@posts.length >= 9)
+      @last_posts = @posts.last(3)
+    elsif @posts.length == 7
+      @last_posts = []
+      @last_posts << @posts.last
+    end
   end
 
   def show
     response = IrisRails::Post.find(params[:slug])
     @post, @related_posts, @account = response
     @author = author_name_or_email(@post.author)
+    strongkeyphrase = '<strong>' + @post.keyphrase + '</strong>'
+    @post.first_introduction = @post.first_introduction.gsub(@post.keyphrase, strongkeyphrase)
+    @post.second_introduction = @post.second_introduction.gsub(@post.keyphrase, strongkeyphrase)
+    @post.ordered_topics.each do |topic|
+      topic['content'] = topic['content'].gsub(@post.keyphrase, strongkeyphrase)
+    end
   end
 
   private
 
   def author_name_or_email(author)
     if author['first_name'] || author['last_name']
-      "#{author['first_name'] } #{author['last_name'] }"
+      "#{author['first_name'].strip} #{author['last_name'].strip}"
     else
       author['email']
     end

data/lib/generators/templates/app/helpers/meta_tags_helper.rb

@@ -4,25 +4,35 @@ module MetaTagsHelper
       set_title(meta_tags[:head_title]),
       meta_title(meta_tags[:head_title]),
       meta_description(meta_tags[:meta_description]),
-      meta_keywords(meta_tags[:meta_keywords])
+      meta_keywords(meta_tags[:meta_keywords]),
+      meta_author(meta_tags[:meta_author]),
+      set_iris_css
     ].join("\n").html_safe
   end
 
   private
 
   def set_title(given_title)
-    content_for?(:title) ? content_tag(:title, 'Iris | ' + content_for(:title)) : (content_tag(:title, given_title) if !given_title.empty?)
+    content_for?(:title) ? content_tag(:title, content_for(:account_name) + ' | ' + content_for(:title)) : (content_tag(:title, given_title) if !given_title.nil?)
   end
 
   def meta_title(given_meta_title)
-    content_for?(:title) ? tag('meta', :name => 'title', :content => content_for(:title)) : (tag('meta', :name => 'title', :content => given_meta_title) if !given_meta_title.empty?)
+    content_for?(:title) ? tag('meta', name: 'title', :content => content_for(:title)) : (tag('meta', :name => 'title', :content => given_meta_title) if !given_meta_title.nil?)
   end
 
   def meta_description(given_meta_description)
-    content_for?(:meta_description) ? tag('meta', :name => 'description', :content => content_for(:meta_description)) : (tag('meta', :name => 'description', :content => given_meta_description) if !given_meta_description.empty?)
+    content_for?(:meta_description) ? tag('meta', name: 'description', :content => content_for(:meta_description)) : (tag('meta', :name => 'description', :content => given_meta_description) if !given_meta_description.nil?)
   end
 
   def meta_keywords(given_meta_keywords)
-    content_for?(:meta_keywords) ? tag('meta', :name => 'keywords', :content => content_for(:meta_keywords)) : (tag('meta', :name => 'keywords', :content => given_meta_keywords) if !given_meta_keywords.empty?)
+    content_for?(:meta_keywords) ? tag('meta', name: 'keywords', :content => content_for(:meta_keywords)) : (tag('meta', :name => 'keywords', :content => given_meta_keywords) if !given_meta_keywords.nil?)
+  end
+
+  def meta_author(given_meta_author)
+    content_for?(:meta_author) ? tag('meta', name: 'author', :content => content_for(:meta_author)) : (tag('meta', :name => 'author', :content => given_meta_author) if !given_meta_author.nil?)
+  end
+
+  def set_iris_css
+    tag(:link, href: "https://cdn.jsdelivr.net/npm/iris-cms/templates/#{content_for(:iris_css)}.css", rel: 'stylesheet') if content_for?(:iris_css)
   end
 end

data/lib/generators/templates/app/views/iris_rails/posts/index.html.erb

@@ -1,6 +1,8 @@
-<% content_for :title, @account.account_title %>
-<% content_for :meta_description, @account.account_description %>
-<% content_for :meta_keywords, @account.account_keyword %>
+<% content_for :title, @account.account_title
+content_for :account_name, @account.account_name
+content_for :meta_description, @account.account_description
+content_for :meta_keywords, @account.account_keyword
+content_for :iris_css, @account.template %>
 
 <div id="blog">
   <div id="iris-main-container">
@@ -9,7 +11,7 @@
         <h1 class="sub-title"><%= @account.account_name %></h1>
       </div>
       <div class="blog_grid">
-        <% @first_posts.each do |post| %>
+        <% @first_posts&.each do |post| %>
           <a href='<%= "/blog/#{post.slug}" %> '>
             <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
               <div class="banner-info">
@@ -24,56 +26,60 @@
       </div>
     </section>
     <section>
-      <div class="sub-title-div">
-        <h2 class="sub-title">EM DESTAQUE</h2>
-      </div>
-      <div class="highlighted-posts">
-        <% @highlighted_posts.each do |post| %>
-          <a href='<%= "/blog/#{post.slug}" %> '>
-            <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
-              <div class="banner-info">
-                <p class="updatedinfo">Atualizado em <%= post.updated_at.to_time.strftime '%e/%m/%Y' %></p>
-                <hr>
-                <h3><%= post.main_title %></h3>
+      <% if @highlighted_posts %>
+        <div class="sub-title-div">
+          <h2 class="sub-title">EM DESTAQUE</h2>
+        </div>
+        <div class="highlighted-posts">
+          <% @highlighted_posts.each do |post| %>
+            <a href='<%= "/blog/#{post.slug}" %> '>
+              <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
+                <div class="banner-info">
+                  <p class="updatedinfo">Atualizado em <%= post.updated_at.to_time.strftime '%e/%m/%Y' %></p>
+                  <hr>
+                  <h3><%= post.main_title %></h3>
+                </div>
               </div>
-            </div>
-            <p class="description"><%= post.secondary_title %></p>
-          </a>
-        <% end %>
-      </div>
+              <p class="description"><%= post.secondary_title %></p>
+            </a>
+          <% end %>
+        </div>
+      <% end %>
     </section>
     <section>
-      <div class="sub-title-div">
-        <h2 class="sub-title">MAIS NOTÍCIAS</h2>
-      </div>
-      <div class="more-posts">
-        <% @more_posts.each do |post| %>
-          <a href='<%= "/blog/#{post.slug}" %> '>
-            <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
-              <div class="banner-info">
-                <p class="updatedinfo">Atualizado em <%= post.updated_at.to_time.strftime '%e/%m/%Y' %></p>
-                <hr>
-                <h3><%= post.main_title %></h3>
+      <% if @more_posts || @last_posts %>
+        <div class="sub-title-div">
+          <h2 class="sub-title">MAIS NOTÍCIAS</h2>
+        </div>
+        <div class="more-posts">
+          <% @more_posts&.each do |post| %>
+            <a href='<%= "/blog/#{post.slug}" %> '>
+              <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
+                <div class="banner-info">
+                  <p class="updatedinfo">Atualizado em <%= post.updated_at.to_time.strftime '%e/%m/%Y' %></p>
+                  <hr>
+                  <h3><%= post.main_title %></h3>
+                </div>
               </div>
-            </div>
-            <p class="description"><%= post.secondary_title %></p>
-          </a>
-        <% end %>
-      </div>
-      <div class="last-three-posts">
-        <% @last_posts.each do |post| %>
-          <a href='<%= "/blog/#{post.slug}" %> '>
-            <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
-              <div class="banner-info">
-                <p class="updatedinfo">Atualizado em <%= post.updated_at.to_time.strftime '%e/%m/%Y' %></p>
-                <hr>
-                <h3><%= post.main_title %></h3>
+              <p class="description"><%= post.secondary_title %></p>
+            </a>
+          <% end %>
+        </div>
+        <div class="last-three-posts">
+          <% @last_posts&.each do |post| %>
+            <a href='<%= "/blog/#{post.slug}" %> '>
+              <div class="post-div" style="background-image: url(<%= post.banner_image['url'] %>);">
+                <div class="banner-info">
+                  <p class="updatedinfo">Atualizado em <%= post.updated_at.to_time.strftime '%e/%m/%Y' %></p>
+                  <hr>
+                  <h3><%= post.main_title %></h3>
+                </div>
               </div>
-            </div>
-            <p class="description"><%= post.secondary_title %></p>
-          </a>
-        <% end %>
-      </div>
+              <p class="description"><%= post.secondary_title %></p>
+            </a>
+          <% end %>
+        </div>
+      <% end %>
     </section>
   </div>
 </div>

data/lib/generators/templates/app/views/iris_rails/posts/show.html.erb

@@ -1,6 +1,9 @@
-<% content_for :title, @post.main_title %>
-<% content_for :meta_description, @post.meta_description %>
-<% content_for :meta_keywords, @post.keyphrase %>
+<% content_for :title, @post.main_title 
+content_for :account_name, @account.account_name
+content_for :meta_description, @post.meta_description
+content_for :meta_keywords, @post.keyphrase
+content_for :meta_author, @author
+content_for :iris_css, @account.template %>
 
 <main id="blog" style="opacity: 1; transition: all 1s ease 0s;">
   <article id="iris-main-container">

data/lib/generators/templates/config/initializers/iris_rails.rb

@@ -1,2 +1,2 @@
-require 'iris-rails'
+require 'iris_rails'
 IrisRails::api_token = ENV['IRIS_TOKEN']

data/lib/iris/version.rb

@@ -1,3 +1,3 @@
 module Iris
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: iris_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rayan Castro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,15 +84,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- iris.gemspec
+- iris_rails.gemspec
 - lib/generators/iris/install_generator.rb
+- lib/generators/lib/iris_rails.rb
 - lib/generators/templates/app/controllers/iris_rails/base_controller.rb
 - lib/generators/templates/app/controllers/iris_rails/posts_controller.rb
 - lib/generators/templates/app/helpers/meta_tags_helper.rb
 - lib/generators/templates/app/views/iris_rails/posts/index.html.erb
 - lib/generators/templates/app/views/iris_rails/posts/show.html.erb
 - lib/generators/templates/config/initializers/iris_rails.rb
-- lib/iris-rails.rb
 - lib/iris/version.rb
 homepage: https://github.com/horta-tech/iris-rails
 licenses: